Create a Business+ Docker resource from Git and queue its first immutable build

POST

/api/docker/nodes/{nodeId}/source-resources

curl --request POST \
  --url https://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/source-resources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source": { "connectorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "branch": "example", "dockerfilePath": "Dockerfile", "contextPath": ".", "composeFilePath": "example", "composeVariables": {}, "composeSecretKeys": [], "autoBuild": true, "autoDeploy": true, "buildArgs": {}, "buildSecretNames": [], "applicationRoot": "example", "packageManager": "npm", "packageManagerVersion": "example", "nodeVersion": "20", "buildScript": "example", "artifactDirectory": "example", "publishTag": "example", "policy": {} }, "resource": { "kind": "container", "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "restartPolicy": "no", "runtimeProfile": "default" } }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Optional retry key (1-255 printable ASCII characters), bound to your token or session and its current scopes. A retry with the same key and request within 24 hours replays the original response with Idempotency-Replayed: true; a different request under the same key returns 422 IDEMPOTENCY_KEY_REUSED, a retry while the first request still runs returns 409 IDEMPOTENCY_KEY_IN_PROGRESS with Retry-After, and a completed request whose response was not stored returns 409 IDEMPOTENCY_RESPONSE_WITHHELD.

Request Body^required

JSON request body

Media typeapplication/json

object

source

required

object

connectorId

required

string format: uuid

projectId

required

string format: uuid

branch

required

string

>= 1 characters <= 500 characters

dockerfilePath

string

default: Dockerfile >= 1 characters <= 500 characters

contextPath

string

default: . >= 1 characters <= 500 characters

composeFilePath

string

>= 1 characters <= 500 characters

composeVariables

object

key

additional properties

string

<= 65536 characters

composeSecretKeys

Array<string>

default: <= 256 items

autoBuild

boolean

default: true

autoDeploy

boolean

default: true

buildArgs

object

key

additional properties

string

<= 16384 characters

buildSecretNames

Array<string>

default: <= 128 items

applicationRoot

string

>= 1 characters <= 500 characters

packageManager

string

Allowed values: npm pnpm yarn

packageManagerVersion

string

>= 1 characters <= 64 characters

nodeVersion

string

Allowed values: 20 22 24

buildScript

string

>= 1 characters <= 128 characters

artifactDirectory

string

>= 1 characters <= 500 characters

publishTag

string

>= 1 characters <= 63 characters /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/

policy

object

vulnerabilityThreshold

string

Allowed values: critical high medium low none disabled

vulnerabilityScope

string

Allowed values: all application

resource

required

One of:

object

object

kind

required

string

Allowed values: container

folderId

string | null format: uuid

name

required

string

>= 1 characters <= 255 characters

restartPolicy

string

default: no

Allowed values: no always unless-stopped on-failure

runtimeProfile

string

default: default

Allowed values: default secure

object

object

kind

required

string

Allowed values: deployment

folderId

string | null format: uuid

name

required

string

>= 2 characters <= 80 characters /^[a-zA-Z0-9][a-zA-Z0-9_.-]+$/

routes

required

Array<object>

>= 1 items <= 32 items

object

hostPort

required

integer

>= 1 <= 65535

containerPort

required

integer

>= 1 <= 65535

isPrimary

boolean

health

object

path

string

default: / >= 1 characters <= 500 characters

statusMin

integer

default: 200 >= 100 <= 599

statusMax

integer

default: 399 >= 100 <= 599

timeoutSeconds

integer

default: 5 >= 1 <= 60

intervalSeconds

integer

default: 5 >= 1 <= 60

successThreshold

integer

default: 2 >= 1 <= 20

startupGraceSeconds

integer

default: 5 <= 600

deployTimeoutSeconds

integer

default: 300 >= 5 <= 3600

drainSeconds

integer

default: 30 <= 3600

routerImage

string

default: nginx:alpine >= 1 characters

restartPolicy

string

default: unless-stopped

Allowed values: no always unless-stopped on-failure

runtimeProfile

string

default: default

Allowed values: default secure

Responses

201

Created

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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"
}