Connect or change the Git source of a blue/green deployment

PUT

/api/docker/nodes/{nodeId}/deployments/{deploymentId}/source

curl --request PUT \
  --url https://opfield.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/deployments/550e8400-e29b-41d4-a716-446655440000/source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "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": {} }'

• Your Opfield instance

Saves the Git source: connector, repository (projectId), branch, Dockerfile or Compose file and context, build arguments, Build Secret names, automatic build and deploy, and the security policy (vulnerabilityThreshold, vulnerabilityScope all | application | fixable_application | fixable_all). Connecting a source or changing its connector, repository or branch also needs integrations::use on the repository. Requires docker:containers:edit on the deployment.

Authorizations

• bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

deploymentId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

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

Findings that count against the threshold: all = every package; application = OS packages (deb, rpm, apk, alpm) are report-only; fixable_application = only findings with a released fix, OS packages report-only; fixable_all = only findings with a released fix in any package. Default all.

string

Allowed values: all application fixable_application fixable_all

Responses

200

Successful response

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"
}