Set the volumes of a container before its first build

PUT

/api/docker/nodes/{nodeId}/containers/{containerName}/source/pending/volumes

curl --request PUT \
  --url https://opfield.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/containers/example/source/pending/volumes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "volumes": [ { "name": "example", "containerPath": "example", "readOnly": false } ] }'

• Your Opfield instance

Replaces the managed volume mounts the first build creates the container with ({ volumes: [{ name, containerPath, readOnly }] }). Each volume needs docker:volumes:view; one volume per path (400 DOCKER_MOUNT_TARGET_DUPLICATE). 409 SOURCE_CONTAINER_BUILT once the container exists (change its Settings instead). Requires docker:containers:edit on the container.

Authorizations

• bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

containerName

required

string

>= 1 characters

Example

example

Request Body^required

JSON request body

Media typeapplication/json

object

volumes

required

Array<object>

<= 64 items

object

name

required

string

>= 1 characters <= 255 characters

containerPath

required

string

>= 1 characters <= 4096 characters

readOnly

boolean

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