integrations

Reference

Integrations

Delete an integration configuration

delete/v1/integrations/configuration/{id}

Allows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configuration/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
id	string required

Response

The configuration was successfully removed

Response Codes

Code	Description
`204`	The configuration was successfully removed
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`	The configuration was not found

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configuration/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Retrieve an integration configuration

get/v1/integrations/configuration/{id}

Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configuration/icfg_cuwj0AdCdH3BwWT4LPijCC7t?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
id	string required ID of the configuration to check Example:`icfg_cuwj0AdCdH3BwWT4LPijCC7t`

Response Codes

Code	Description
`200`	The configuration with the provided id
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`	The configuration was not found

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configuration/icfg_cuwj0AdCdH3BwWT4LPijCC7t?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Get configurations for the authenticated user or team

get/v1/integrations/configurations

Allows to retrieve all configurations for an authenticated integration. When the project view is used, configurations generated for the authorization flow will be filtered out of the results.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configurations?view=account&installationType=marketplace&integrationIdOrSlug=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
view	string of the following required Allowed values:`accountproject`
installationType	string of the following Allowed values:`marketplaceexternal`
integrationIdOrSlug	string ID of the integration
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response Codes

Code	Description
`200`	The list of configurations for the authenticated user
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/configurations?view=account&installationType=marketplace&integrationIdOrSlug=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

List git namespaces by provider

get/v1/integrations/git-namespaces

Lists git namespaces for a supported provider. Supported providers are github, gitlab and bitbucket. If the provider is not provided, it will try to obtain it from the user that authenticated the request.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/git-namespaces?host=ghes-test.now.systems&provider=github", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
host	string The custom Git host if using a custom Git provider, like GitHub Enterprise Server Example:`ghes-test.now.systems`
provider	string of the following Allowed values:`githubgithub-custom-hostgitlabbitbucket`

Response

array
Array

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/git-namespaces?host=ghes-test.now.systems&provider=github", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

List git repositories linked to namespace by provider

get/v1/integrations/search-repo

Lists git repositories linked to a namespace id for a supported provider. A specific namespace id can be obtained via the git-namespaces endpoint. Supported providers are github, gitlab and bitbucket. If the provider or namespace is not provided, it will try to obtain it from the user that authenticated the request.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/search-repo?host=ghes-test.now.systems&installationId=SOME_STRING_VALUE&namespaceId=SOME_string|number_VALUE&provider=github&query=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
host	string The custom Git host if using a custom Git provider, like GitHub Enterprise Server Example:`ghes-test.now.systems`
installationId	string
namespaceId
provider	string of the following Allowed values:`githubgithub-custom-hostgitlabbitbucket`
query	string
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

One of the following objects
One of

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/integrations/search-repo?host=ghes-test.now.systems&installationId=SOME_STRING_VALUE&namespaceId=SOME_string|number_VALUE&provider=github&query=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Last updated on November 24, 2024

Update an Edge Config

Delete an integration configuration

Was this helpful?