Integrations API

The Integrations API allows you to manage third-party integrations in your Kubiya organization. You can list, create, update, and delete integrations with various vendors.

No endpoints found for the specified API type: Integrations

Endpoints

Method	Path	Description
GET	`/api/v1/integrations`	List all integrations
DELETE	`/api/v1/integrations/{vendor}`	Delete an integration
GET	`/api/v1/oauth_integration/{vendor}`	Get OAuth URL for integration
POST	`/api/v1/integrations/{vendor}/status`	Toggle integration status
GET	`/api/v1/integration/{vendor}/install`	Get installation URL
GET	`/api/v1/integration/{vendor}/token/{integrationId}`	Get integration token
GET	`/api/v1/integration/{vendor}/callback`	OAuth callback endpoint

List Integrations

Retrieve all integrations in your organization.

GET /api/v1/integrations

Headers

Name	Required	Description
`Authorization`	Yes	UserKey YOUR_API_KEY

Response

{
  "integrations": [
    {
      "vendor": "github",
      "status": "active",
      "installed_at": "2024-03-20T10:00:00Z"
    }
  ]
}

Delete Integration

Delete an integration with a specific vendor.

DELETE /api/v1/integrations/{vendor}

Path Parameters

Name	Type	Required	Description
`vendor`	string	Yes	Name of the vendor (e.g., github, gitlab)

Headers

Name	Required	Description
`Authorization`	Yes	UserKey YOUR_API_KEY

Response

A successful delete operation returns an HTTP 200 status with no response body.

Get OAuth URL

Get the OAuth URL for integrating with a vendor.

GET /api/v1/oauth_integration/{vendor}

Path Parameters

Name	Type	Required	Description
`vendor`	string	Yes	Name of the vendor (e.g., github, gitlab)

Headers

Name	Required	Description
`Authorization`	Yes	UserKey YOUR_API_KEY

Response

{
  "url": "https://vendor.com/oauth/authorize?client_id=...&redirect_uri=..."
}

Toggle Integration Status

Enable or disable an integration.

POST /api/v1/integrations/{vendor}/status

Path Parameters

Name	Type	Required	Description
`vendor`	string	Yes	Name of the vendor (e.g., github, gitlab)

Headers

Name	Required	Description
`Authorization`	Yes	UserKey YOUR_API_KEY
`Content-Type`	Yes	application/json

Request Body

{
  "enabled": true
}

Response

{
  "status": "success",
  "message": "Integration status updated"
}

Get Installation URL

Get the installation URL for a vendor's integration.

GET /api/v1/integration/{vendor}/install

Path Parameters

Name	Type	Required	Description
`vendor`	string	Yes	Name of the vendor (e.g., github, gitlab)

Headers

Name	Required	Description
`Authorization`	Yes	UserKey YOUR_API_KEY

Response

{
  "url": "https://vendor.com/install/..."
}

Get Integration Token

Retrieve the access token for an integration.

GET /api/v1/integration/{vendor}/token/{integrationId}

Integrations API

On this page