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})
Path Parameter | Description |
---|---|
id | string required |
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})
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})
Path Parameter | Description |
---|---|
id | string requiredID of the configuration to check Example: icfg_cuwj0AdCdH3BwWT4LPijCC7t |
One of the following objects
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})
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})
Query Parameter | Description |
---|---|
view | string of the following requiredAllowed values: account project |
installationType | string of the following Allowed values: marketplace external |
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. |
One of the following objects
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})
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})
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: github github-custom-host gitlab bitbucket |
array
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})
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})
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: github github-custom-host gitlab bitbucket |
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. |
One of the following objects
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})
Was this helpful?