Documentation - Dooor OS

Git Integration

Git integration allows your workspace to connect to GitHub via the Dooor GitHub App. Once installed, you can browse repositories and branches to configure app deployments.

Get Install URL

GET/workspaces/{wsId}/git/install-url

Returns a GitHub App installation URL with a signed state parameter. Redirect the user to this URL to begin the GitHub App installation flow.

Note: Redirect the user to the returned url value. GitHub will call back to your configured redirect URI after the user approves the installation.

Response

json

{
  "url": "https://github.com/apps/dooor-os/installations/new?state=eyJhbGci..."
}

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/install-url" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Connect GitHub

POST/workspaces/{wsId}/git/connect

Completes the GitHub App installation by persisting the installation details returned from the GitHub callback. Call this endpoint after GitHub redirects back to your app.

Request Body

Name	Type	Required	Description
installationId	string	required	The GitHub App installation ID returned in the callback query params
setupAction	string	optional	Action that triggered the callback. Usually "install" or "update". Optional.

Response

json

{
  "id": "ghi_01hx...",
  "provider": "github",
  "accountLogin": "my-org",
  "accountType": "Organization",
  "installationId": "123456",
  "status": "active",
  "createdAt": "2025-04-17T12:00:00Z"
}

bash

curl -X POST "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/connect" \
  -H "Authorization: Bearer dor_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "installationId": "123456",
    "setupAction": "install"
  }'

List Installations

GET/workspaces/{wsId}/git/installations

Returns a paginated list of GitHub App installations connected to this workspace.

Query Parameters

Name	Type	Required	Description
page	integer	optional	Page number, starting at 1. Default: 1
limit	integer	optional	Items per page. Default: 20, max: 100

Response

json

{
  "data": [
    {
      "id": "ghi_01hx...",
      "provider": "github",
      "accountLogin": "my-org",
      "accountType": "Organization",
      "status": "active"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/installations?page=1&limit=20" \
  -H "Authorization: Bearer dor_sk_your_key_here"

List Repositories

GET/workspaces/{wsId}/git/repos

Returns repositories accessible to a specific GitHub App installation. Use the installationId from a connected installation.

Query Parameters

Name	Type	Required	Description
installationId	string	required	ID of the connected GitHub App installation
page	integer	optional	Page number, starting at 1. Default: 1
limit	integer	optional	Items per page. Default: 20, max: 100

Response

json

[
  {
    "id": 123456789,
    "name": "my-api",
    "fullName": "my-org/my-api",
    "private": true,
    "defaultBranch": "main",
    "updatedAt": "2025-04-10T09:00:00Z"
  }
]

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/repos?installationId=123&page=1&limit=20" \
  -H "Authorization: Bearer dor_sk_your_key_here"

List Branches

GET/workspaces/{wsId}/git/repos/{owner}/{repo}/branches

Returns the list of branches for a repository accessible via the given installation.

Query Parameters

Name	Type	Required	Description
installationId	string	required	ID of the connected GitHub App installation

Response

json

[
  { "name": "main", "protected": true },
  { "name": "develop", "protected": false },
  { "name": "feat/new-api", "protected": false }
]

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/repos/my-org/my-api/branches?installationId=123" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Remove Installation

DELETE/workspaces/{wsId}/git/installations/{installationId}

Deactivates a GitHub App installation from the workspace. Existing apps linked to this installation will no longer receive automatic deploys.

Response

json

{
  "id": "ghi_01hx...",
  "status": "inactive",
  "deactivatedAt": "2025-04-17T15:00:00Z"
}

bash

curl -X DELETE "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/installations/{installationId}" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Git Integration

Git integration allows your workspace to connect to GitHub via the Dooor GitHub App. Once installed, you can browse repositories and branches to configure app deployments.

Get Install URL

GET/workspaces/{wsId}/git/install-url

Returns a GitHub App installation URL with a signed state parameter. Redirect the user to this URL to begin the GitHub App installation flow.

Note: Redirect the user to the returned url value. GitHub will call back to your configured redirect URI after the user approves the installation.

Response

json

{
  "url": "https://github.com/apps/dooor-os/installations/new?state=eyJhbGci..."
}

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/install-url" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Connect GitHub

POST/workspaces/{wsId}/git/connect

Completes the GitHub App installation by persisting the installation details returned from the GitHub callback. Call this endpoint after GitHub redirects back to your app.

Request Body

Name	Type	Required	Description
installationId	string	required	The GitHub App installation ID returned in the callback query params
setupAction	string	optional	Action that triggered the callback. Usually "install" or "update". Optional.

Response

json

{
  "id": "ghi_01hx...",
  "provider": "github",
  "accountLogin": "my-org",
  "accountType": "Organization",
  "installationId": "123456",
  "status": "active",
  "createdAt": "2025-04-17T12:00:00Z"
}

bash

curl -X POST "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/connect" \
  -H "Authorization: Bearer dor_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "installationId": "123456",
    "setupAction": "install"
  }'

List Installations

GET/workspaces/{wsId}/git/installations

Returns a paginated list of GitHub App installations connected to this workspace.

Query Parameters

Name	Type	Required	Description
page	integer	optional	Page number, starting at 1. Default: 1
limit	integer	optional	Items per page. Default: 20, max: 100

Response

json

{
  "data": [
    {
      "id": "ghi_01hx...",
      "provider": "github",
      "accountLogin": "my-org",
      "accountType": "Organization",
      "status": "active"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/installations?page=1&limit=20" \
  -H "Authorization: Bearer dor_sk_your_key_here"

List Repositories

GET/workspaces/{wsId}/git/repos

Returns repositories accessible to a specific GitHub App installation. Use the installationId from a connected installation.

Query Parameters

Name	Type	Required	Description
installationId	string	required	ID of the connected GitHub App installation
page	integer	optional	Page number, starting at 1. Default: 1
limit	integer	optional	Items per page. Default: 20, max: 100

Response

json

[
  {
    "id": 123456789,
    "name": "my-api",
    "fullName": "my-org/my-api",
    "private": true,
    "defaultBranch": "main",
    "updatedAt": "2025-04-10T09:00:00Z"
  }
]

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/repos?installationId=123&page=1&limit=20" \
  -H "Authorization: Bearer dor_sk_your_key_here"

List Branches

GET/workspaces/{wsId}/git/repos/{owner}/{repo}/branches

Returns the list of branches for a repository accessible via the given installation.

Query Parameters

Name	Type	Required	Description
installationId	string	required	ID of the connected GitHub App installation

Response

json

[
  { "name": "main", "protected": true },
  { "name": "develop", "protected": false },
  { "name": "feat/new-api", "protected": false }
]

bash

curl -X GET "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/repos/my-org/my-api/branches?installationId=123" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Remove Installation

DELETE/workspaces/{wsId}/git/installations/{installationId}

Deactivates a GitHub App installation from the workspace. Existing apps linked to this installation will no longer receive automatic deploys.

Response

json

{
  "id": "ghi_01hx...",
  "status": "inactive",
  "deactivatedAt": "2025-04-17T15:00:00Z"
}

bash

curl -X DELETE "https://os-develop.dooor.ai/api/v1/workspaces/{wsId}/git/installations/{installationId}" \
  -H "Authorization: Bearer dor_sk_your_key_here"

Git Integration#

Get Install URL#

Response

Connect GitHub#

Request Body

Response

List Installations#

Query Parameters

Response

List Repositories#

Query Parameters

Response

List Branches#

Query Parameters

Response

Remove Installation#

Response

Git Integration#

Get Install URL#

Response

Connect GitHub#

Request Body

Response

List Installations#

Query Parameters

Response

List Repositories#

Query Parameters

Response

List Branches#

Query Parameters

Response

Remove Installation#

Response

Git Integration

Get Install URL

Connect GitHub

List Installations

List Repositories

List Branches

Remove Installation

Git Integration

Get Install URL

Connect GitHub

List Installations

List Repositories

List Branches

Remove Installation