Note: The VCS Events API is still in beta as support is being added for additional VCS providers. Currently only GitLab.com connections established after December 2020 are supported.
VCS (version control system) events describe changes within your organization for VCS-related actions. Events are only stored for 10 days. If information about the OAuth Client or OAuth Token are available at the time of the event, it will be logged with the event.
Note: Viewing VCS events is restricted to the owners team, teams with the "Manage VCS Settings", and the organization API token. (More about permissions.)
$ curl \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z&filter%5Bto%5D=2021-02-12T14%3A09%3A59Z&filter%5Boauth_client_external_ids%5D=oc-hhTM7WNUUgbXJpkW&filter%5Blevels%5D=info&include=oauth_client
$ curl \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/vnd.api+json" \
https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z&filter%5Bto%5D=2021-02-12T14%3A09%3A59Z&filter%5Boauth_client_external_ids%5D=oc-hhTM7WNUUgbXJpkW&filter%5Blevels%5D=info&include=oauth_client
{
"data": [
{
"id": "ve-DJpbEwZc98ZedHZG",
"type": "vcs-events",
"attributes": {
"created-at": "2021-02-09 20:07:49.686182 +0000 UTC",
"level": "info",
"message": "Loaded 11 repositories",
"organization-id": "org-SBVreZxVessAmCZG"
},
"relationships": {
"oauth-client": {
"data": {
"id": "oc-LePsVhHXhCM6jWf3",
"type": "oauth-clients"
},
"links": {
"related": "/api/v2/oauth-clients/oc-LePsVhHXhCM6jWf3"
}
},
"oauth-token": {
"data": {
"id": "ot-Ma2cs8tzjv3LYZHw",
"type": "oauth-tokens"
},
"links": {
"related": "/api/v2/oauth-tokens/ot-Ma2cs8tzjv3LYZHw"
}
}
}
}
],
"included": [
{
"id": "oc-LePsVhHXhCM6jWf3",
"type": "oauth-clients",
"attributes": {
"name": "working",
"service-provider": "gitlab_hosted"
},
"relationships": {
"organization": {
"data": {
"id": "my-organization",
"type": "organizations"
},
"links": {
"related": "/api/v2/organizations/my-organization"
}
},
"oauth-tokens": {
"data": [
{
"id": "ot-Ma2cs8tzjv3LYZHw",
"type": "oauth-tokens"
}
]
}
}
}
],
"links": {
"self": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20",
"first": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20",
"prev": null,
"next": null,
"last": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20"
},
"meta": {
"pagination": {
"current-page": 1,
"prev-page": null,
"next-page": null,
"total-pages": 1,
"total-count": 8
}
}
}
{
"data": [
{
"id": "ve-DJpbEwZc98ZedHZG",
"type": "vcs-events",
"attributes": {
"created-at": "2021-02-09 20:07:49.686182 +0000 UTC",
"level": "info",
"message": "Loaded 11 repositories",
"organization-id": "org-SBVreZxVessAmCZG"
},
"relationships": {
"oauth-client": {
"data": {
"id": "oc-LePsVhHXhCM6jWf3",
"type": "oauth-clients"
},
"links": {
"related": "/api/v2/oauth-clients/oc-LePsVhHXhCM6jWf3"
}
},
"oauth-token": {
"data": {
"id": "ot-Ma2cs8tzjv3LYZHw",
"type": "oauth-tokens"
},
"links": {
"related": "/api/v2/oauth-tokens/ot-Ma2cs8tzjv3LYZHw"
}
}
}
}
],
"included": [
{
"id": "oc-LePsVhHXhCM6jWf3",
"type": "oauth-clients",
"attributes": {
"name": "working",
"service-provider": "gitlab_hosted"
},
"relationships": {
"organization": {
"data": {
"id": "my-organization",
"type": "organizations"
},
"links": {
"related": "/api/v2/organizations/my-organization"
}
},
"oauth-tokens": {
"data": [
{
"id": "ot-Ma2cs8tzjv3LYZHw",
"type": "oauth-tokens"
}
]
}
}
}
],
"links": {
"self": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20",
"first": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20",
"prev": null,
"next": null,
"last": "https://app.terraform.io/api/v2/organizations/my-organization/vcs-events?filter%5Bfrom%5D=2021-02-02T14%3A09%3A00Z\u0026filter%5Blevels%5D=info\u0026filter%5Boauth_client_external_ids%5D=oc-LePsVhHXhCM6jWf3\u0026filter%5Bto%5D=2021-02-12T14%3A09%3A59Z\u0026include=oauth_client\u0026organization_name=my-organization\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=20"
},
"meta": {
"pagination": {
"current-page": 1,
"prev-page": null,
"next-page": null,
"total-pages": 1,
"total-count": 8
}
}
}