Integrations API

Source-control integrations and GitHub App

REST API endpoints for Integrations. 8 operations.

List source-control integrations

plaintext

GET /v1/integrations

Returns all GitHub/GitLab/Bitbucket integrations attached to the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	All integrations for the caller's project
`400`	API key must be project-scoped
`401`	Missing or invalid credentials
`500`	Internal error

operationId: listIntegrations

Create a source-control integration

plaintext

POST /v1/integrations

Attaches a Git provider repo to the caller's project and returns the created integration plus the webhook URL and secret to configure on the provider.

Auth: Bearer API key

Request body

application/json (required) — schema CreateIntegrationBody.

Responses

Status	Description
`201`	Integration created; returns webhook URL + secret
`400`	Invalid provider or duplicate integration
`401`	Missing or invalid credentials
`500`	Internal error

operationId: createIntegration

Delete a source-control integration

plaintext

DELETE /v1/integrations/{id}

Detaches a Git provider repo from the caller's project and deletes the integration record.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Integration id (UUID)

Responses

Status	Description
`204`	Integration deleted
`401`	Missing or invalid credentials
`404`	Integration not found
`500`	Internal error

operationId: deleteIntegration

Get a source-control integration

plaintext

GET /v1/integrations/{id}

Returns a single integration by id, scoped to the caller's project.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Integration id (UUID)

Responses

Status	Description
`200`	The integration
`401`	Missing or invalid credentials
`404`	Integration not found
`500`	Internal error

operationId: getIntegration

Update a source-control integration

plaintext

PUT /v1/integrations/{id}

Updates an integration's build/deploy settings (branch filter, auto-build, auto-deploy, preview, status) and returns the updated record.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Integration id (UUID)

Request body

application/json (required) — schema UpdateIntegrationBody.

Responses

Status	Description
`200`	The updated integration
`401`	Missing or invalid credentials
`404`	Integration not found
`500`	Internal error

operationId: updateIntegration

List GitHub App installations

plaintext

GET /v1/integrations/github/installations

Returns the GitHub App installations registered to the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	GitHub App installations for the project
`401`	Missing or invalid credentials
`500`	Internal error

operationId: listGithubInstallations

Mint an installation token

plaintext

POST /v1/integrations/github/installations/{installation_id}/token

Returns a short-lived GitHub App installation access token for an installation owned by the caller's project.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`installation_id`	path	`integer (int64)`	Yes	GitHub App installation id

Responses

Status	Description
`200`	A short-lived installation access token
`401`	Missing or invalid credentials
`404`	Installation not found or not owned by this project
`500`	Internal error

operationId: createGithubInstallationToken

List accessible GitHub repos

plaintext

GET /v1/integrations/github/repos

Returns the repositories the project's GitHub App installations can access, aggregated across all active installations.

Auth: Bearer API key

Responses

Status	Description
`200`	Repositories accessible across the project's installations
`401`	Missing or invalid credentials
`500`	Internal error

operationId: listGithubRepos