Retrieve a branch by immutable id

GET/v1/branches/{id}

Path parameters

idstringrequired

Responses

200The branch.

objectstringrequired

idstringrequired

project_idstringrequired

parent_branch_idstring | anyrequired

Show properties

Any of:

string

string

any

any

slugstringrequired

min length 1 · max length 40 · matches ^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$

namestring | anyrequired

Show properties

Any of:

string

string

any

any

kindstringrequired

Allowed:devpreviewtestlong_lived

statestringrequired

Allowed:provisioningreadyfaileddeletingdeleted

originstringrequired

Allowed:emptysource_snapshotcoordinated_fork

rootbooleanrequired

expires_atstring | anyrequired

Show properties

Any of:

string

string

any

any

created_atstringrequired

deleted_atstring | anyrequired

Show properties

Any of:

string

string

any

any

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

401The Bearer credential is missing, malformed, or expired.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

404The addressed resource does not exist in the credential scope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

409The request conflicts with current claim, version, or idempotency state.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

500The server could not complete the request.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X GET "https://api.abloatai.com/api/v1/branches/string"

const response = await fetch("https://api.abloatai.com/api/v1/branches/string", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.abloatai.com/api/v1/branches/string",
)

Response

{
  "object": "branch",
  "id": "string",
  "project_id": "string",
  "parent_branch_id": "string",
  "slug": "string",
  "name": "string",
  "kind": "dev",
  "state": "provisioning",
  "origin": "empty",
  "root": true,
  "expires_at": "string",
  "created_at": "string",
  "deleted_at": "string"
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}