List Docker and Pages builds

GET

/api/docker/builds

const url = 'https://opfield.example.com/api/docker/builds?status=queued&provider=gitlab&limit=50&excludeAppMembers=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://opfield.example.com/api/docker/builds?status=queued&provider=gitlab&limit=50&excludeAppMembers=true' \
  --header 'Authorization: Bearer <token>'

Builds the caller may view (containers and deployments: docker:containers:view; Compose: docker:compose:view; Pages: pages:view), newest first, with nextCursor. excludeAppMembers and appId filter like the other lists.

Authorizations

bearerAuth

Parameters

Query Parameters

sourceBindingId

string format: uuid

builderNodeId

string format: uuid

status

string

Allowed values: queued claimed checking_out building scanning pushing deploying succeeded failed cancelled superseded

provider

string

Allowed values: gitlab github git

branch

string

<= 500 characters

search

string

<= 500 characters

containerName

string

>= 1 characters <= 255 characters

nodeId

string format: uuid

cursor

string

<= 500 characters

limit

integer

default: 50 >= 1 <= 200

excludeAppMembers

string

Allowed values: true false

appId

string format: uuid

Responses

200

Successful response

application/json

object

data

required

Array<object>

Resource object. Exact fields depend on the endpoint.

object

string

name

string

key

additional properties

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example resource",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "updatedAt": "2024-01-01T12:30:00.000Z"
    }
  ]
}

400

Bad request

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}