Test a container health check

POST

/api/docker/nodes/{nodeId}/containers/{containerName}/health-check/test

curl --request POST \
  --url https://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/containers/example/health-check/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": false, "scheme": "http", "hostPort": 1, "containerPort": 1, "path": "/", "statusMin": 200, "statusMax": 399, "expectedBody": "example", "bodyMatchMode": "includes", "intervalSeconds": 30, "timeoutSeconds": 5, "slowThreshold": 1000 }'

• Your Gateway instance

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

Optional JSON request body

Media typeapplication/json

object

enabled

boolean

scheme

string

default: http

Allowed values: http https

hostPort

integer | null

>= 1 <= 65535

containerPort

integer | null

>= 1 <= 65535

path

string

default: / >= 1 characters <= 500 characters

statusMin

integer

default: 200 >= 100 <= 599

statusMax

integer

default: 399 >= 100 <= 599

expectedBody

string | null

<= 5000 characters

bodyMatchMode

string

default: includes

Allowed values: includes exact starts_with ends_with

intervalSeconds

integer

default: 30 >= 5 <= 86400

timeoutSeconds

integer

default: 5 >= 1 <= 120

slowThreshold

integer

default: 1000 >= 1 <= 120000

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",
    "containerId": "api",
    "status": "healthy",
    "intervalSeconds": 30
  }
}

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