POST /extensions/list

POST/extensions/list

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

namestringrequired

min length 1 · max length 64 · matches ^[a-z0-9][a-z0-9._-]*$

refstring

min length 1

Responses

200OK

refstringrequired

commitShastring | anyrequired

Show properties

Any of:

string

string

any

any

canonicalRefstringrequired

canonicalCommitShastring | anyrequired

Show properties

Any of:

string

string

any

any

itemsobject[]required

Show properties

Array of object

versionanyrequired

namestringrequired

min length 1 · max length 64 · matches ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

descriptionstring

max length 512

pathstringrequired

min length 1

modulePathstringrequired

min length 1

descriptorPathstringrequired

min length 1

moduleHashstringrequired

matches ^sha256:[0-9a-f]{64}$

descriptorHashstringrequired

matches ^sha256:[0-9a-f]{64}$

runtimestring

default: "worker"

Allowed:workersandboxworkflow

capabilitiesstring[]

default: []

Show properties

Array of string

Any of:

string

string

string

string

dispatchboolean

default: false

inputSchemaobject

outputSchemaobject

recordobject

Show properties

namestringrequired

matches ^[A-Za-z][A-Za-z0-9_]*$

fieldsobjectrequired

indexesstring[]

hooksobject

default: {}

Show properties

onCreateboolean

onTransitionboolean

onobject

default: {}

Show properties

pushobject

Show properties

branchesstring[]

pathsstring[]

eventobject

Show properties

typesstring[]required

min items 1 · max items 32

subjectstring

min length 1

fromstring

min length 1

bundlerVersionstringrequired

min length 1

commitShastring | anyrequired

Show properties

Any of:

string

string

any

any

dispatchablebooleanrequired

effectiveCapabilitiesstring[]required

Show properties

Array of string

Any of:

string

string

string

string

canonicalDescriptorHashstring | anyrequired

Show properties

Any of:

string

string

any

any

canonicalGrantHashstring | anyrequired

Show properties

Any of:

string

string

any

any

canonicalSchemaHashstring | anyrequired

Show properties

Any of:

string

string

any

any

schemaAheadbooleanrequired

canonicalbooleanrequired

daemonsobject[]

default: []

Show properties

Array of object

namestringrequired

min length 1 · max length 64 · matches ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

canonicalShastringrequired

min length 1

moduleHashstringrequired

matches ^sha256:[0-9a-f]{64}$

descriptorHashstringrequired

matches ^sha256:[0-9a-f]{64}$

scheduleIntervalMinutesintegerrequired

min 5 · max 9007199254740991

capabilitiesstring[]

default: []

Show properties

Array of string

Any of:

string

string

string

string

onEventTypesstring[] | anyrequired

Show properties

Any of:

string[]

Array of string

string

any

any

statusstringrequired

Allowed:activequarantined

failuresintegerrequired

min 0 · max 9007199254740991

quarantinedUntilinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

nextWakeAtinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

lastRunobject | anyrequired

Show properties

Any of:

object

idstringrequired

min length 1

statusstringrequired

Allowed:succeededfailedcancelled

endedAtintegerrequired

min 0 · max 9007199254740991

any

any

lastWakeAtinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

lastWakeOutcomestring | anyrequired

Show properties

Any of:

string

string

any

any

lastWakeDetailstring | anyrequired

Show properties

Any of:

string

string

any

any

lastConsumerSeenAtinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

lastConsumerDetailstring | anyrequired

Show properties

Any of:

string

string

any

any

pendingEventCountintegerrequired

min 0 · max 9007199254740991

errorsobject[]required

Show properties

Array of object

pathstringrequired

messagestringrequired

400400

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Bad request"

dataobject

Show properties

issuesobject[]

Show properties

Array of object

pathstring | number[]

Show properties

Array of string | number

Any of:

string

string

number

number

messagestringrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

401401

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Sign in required"

dataobject

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

403403

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "You do not have access to this resource"

dataobject

Show properties

reasonstring

Allowed:not_a_memberinsufficient_rolescope_missingwrite_frozen

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

404404

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Extension not found"

dataobjectrequired

Show properties

namestringrequired

extensionstringrequired

refstring

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Run not found"

dataobjectrequired

Show properties

idstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Invitation not found"

dataobjectrequired

Show properties

invitationIdstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Invite not found"

dataobject

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "API key not found"

dataobjectrequired

Show properties

idstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Repo not found"

dataobjectrequired

Show properties

namestringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Git object not found"

dataobjectrequired

Show properties

namestringrequired

objectstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Feature is not available"

dataobjectrequired

Show properties

featureanyrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

409409

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Extension build provenance verification failed"

dataobjectrequired

Show properties

namestringrequired

reasonstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Git ref already exists"

dataobjectrequired

Show properties

namestringrequired

refstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Git ref is stale"

dataobjectrequired

Show properties

namestringrequired

refstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Record migration blocked"

dataobjectrequired

Show properties

namestringrequired

reasonsstring[]required

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Repo already exists"

dataobjectrequired

Show properties

namestringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Cannot delete your last owned organization"

dataobjectrequired

Show properties

slugstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Cannot delete an organization that still owns repos"

dataobjectrequired

Show properties

slugstringrequired

repoCountintegerrequired

min 0 · max 9007199254740991

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Organization slug is already taken"

dataobjectrequired

Show properties

slugstringrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

410410

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Invite is no longer available"

dataobjectrequired

Show properties

reasonstringrequired

Allowed:revokedexpiredexhaustedrepo_unavailable

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

413413

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Request payload exceeds the supported limit"

dataobjectrequired

Show properties

scopestringrequired

Allowed:workspace_commitgit_workspace_memory

limitnumberrequired

observednumber

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

422422

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Extension is invalid"

dataobjectrequired

Show properties

namestringrequired

extensionstring

reasonstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Extension build failed"

dataobjectrequired

Show properties

namestringrequired

messagestringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Run rejected"

dataobjectrequired

Show properties

idstring

reasonstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Git ref update is not a fast-forward"

dataobjectrequired

Show properties

namestringrequired

refstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Invalid git tree"

dataobjectrequired

Show properties

namestringrequired

objectstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Invalid git parent"

dataobjectrequired

Show properties

namestringrequired

objectstringrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

429429

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Too many requests"

dataobject

Show properties

retryAfterMsinteger

min 0 · max 9007199254740991

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Quota exceeded"

dataobjectrequired

Show properties

scopestringrequired

Allowed:anonorgsize

limitnumberrequired

observednumber

projectednumber

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

502502

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Git remote write failed"

dataobjectrequired

Show properties

namestringrequired

refstringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Repo import failed"

dataobjectrequired

Show properties

namestringrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

503503

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Extension build service is unavailable"

dataobjectrequired

Show properties

namestringrequired

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Repo workspace is required for this git operation"

dataobjectrequired

Show properties

namestringrequired

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

Request

curl -X POST "/api/v1/extensions/list" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "ref": "string"
}'

const response = await fetch("/api/v1/extensions/list", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "ref": "string"
})
});

import requests

response = requests.post(
    "/api/v1/extensions/list",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "name": "string",
  "ref": "string"
},
)

Response

{
  "ref": "string",
  "commitSha": "string",
  "canonicalRef": "string",
  "canonicalCommitSha": "string",
  "items": [
    {
      "version": 2,
      "name": "string",
      "description": "string",
      "path": "string",
      "modulePath": "string",
      "descriptorPath": "string",
      "moduleHash": "string",
      "descriptorHash": "string",
      "runtime": "worker",
      "capabilities": [],
      "dispatch": false,
      "inputSchema": {},
      "outputSchema": {},
      "record": {
        "name": "string",
        "fields": {},
        "indexes": [
          "string"
        ],
        "hooks": {}
      },
      "on": {},
      "bundlerVersion": "string",
      "commitSha": "string",
      "dispatchable": true,
      "effectiveCapabilities": [
        "repoRead"
      ],
      "canonicalDescriptorHash": "string",
      "canonicalGrantHash": "string",
      "canonicalSchemaHash": "string",
      "schemaAhead": true,
      "canonical": true
    }
  ],
  "daemons": [],
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad request",
  "data": {
    "issues": [
      {
        "path": [
          "string"
        ],
        "message": "string"
      }
    ]
  }
}

{
  "defined": true,
  "code": "PAYLOAD_TOO_LARGE",
  "status": 413,
  "message": "Request payload exceeds the supported limit",
  "data": {
    "scope": "workspace_commit",
    "limit": 0,
    "observed": 0
  }
}