Diagnose one branch plane

Returns branch lifecycle, active schema, compatibility with the parent schema, safe datasource coordinates, and readiness blockers.

GET/v1/branches/{id}/status

Path parameters

idstringrequired

Responses

200The complete branch readiness view.

objectstringrequired

branchobjectrequired

Show properties

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

readybooleanrequired

schemaobjectrequired

Show properties

activebooleanrequired

versioninteger | anyrequired

Show properties

Any of:

integer

integer

any

any

hashstring | anyrequired

Show properties

Any of:

string

string

any

any

parent_compatibilitystringrequired

Allowed:samecompatiblereviewblockedunknown

changesintegerrequired

min 0 · max 9007199254740991

warningsintegerrequired

min 0 · max 9007199254740991

blockersintegerrequired

min 0 · max 9007199254740991

data_sourceobjectrequired

Show properties

kindstringrequired

Allowed:hosteddirectendpoint

statusstring | anyrequired

Show properties

Any of:

string

string

any

any

hoststring | anyrequired

Show properties

Any of:

string

string

any

any

databasestring | anyrequired

Show properties

Any of:

string

string

any

any

cursorstring | anyrequired

Show properties

Any of:

string

string

any

any

event_lagintegerrequired

min 0 · max 9007199254740991

retry_countintegerrequired

min 0 · max 9007199254740991

last_success_atstring | anyrequired

Show properties

Any of:

string

string

any

any

last_errorstring | anyrequired

Show properties

Any of:

string

string

any

any

blockersobject[]required

Show properties

Array of object

codestringrequired

Allowed:branch_not_readyschema_missingdata_source_not_ready

problemstringrequired

fixstringrequired

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/status"

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

import requests

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

Response

{
  "object": "branch_status",
  "branch": {
    "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"
  },
  "ready": true,
  "schema": {
    "active": true,
    "version": 0,
    "hash": "string",
    "parent_compatibility": "same",
    "changes": 0,
    "warnings": 0,
    "blockers": 0
  },
  "data_source": {
    "kind": "hosted",
    "status": "unverified",
    "host": "string",
    "database": "string",
    "cursor": "string",
    "event_lag": 0,
    "retry_count": 0,
    "last_success_at": "string",
    "last_error": "string"
  },
  "blockers": [
    {
      "code": "branch_not_ready",
      "problem": "string",
      "fix": "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"
    }
  ]
}