List the container links of a workload

GET

/api/docker/container-links

curl --request GET \
  --url 'https://opfield.example.com/api/docker/container-links?nodeId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&type=container&resourceId=example&direction=outgoing' \
  --header 'Authorization: Bearer <token>'

• Your Opfield instance

Direction outgoing (default): the links the workload (container, deployment or Compose service) reaches other workloads through. incoming: the links that reach it. Needs view access to the workload.

Authorizations

• bearerAuth

Parameters

Query Parameters

nodeId

required

string format: uuid

type

required

string

Allowed values: container deployment compose_service

resourceId

required

string

>= 1 characters <= 255 characters

direction

string

default: outgoing

Allowed values: outgoing incoming

Responses

200

Successful response

Media typeapplication/json

object

data

required

Array<object>

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": [
    {
      "id": "nginx-prod",
      "name": "nginx-prod",
      "image": "nginx:1.27",
      "state": "running",
      "ports": [
        "80/tcp"
      ]
    }
  ]
}

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