Get a container link with its relay counters

GET

/api/docker/container-links/{id}/runtime

const url = 'https://opfield.example.com/api/docker/container-links/550e8400-e29b-41d4-a716-446655440000/runtime';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://opfield.example.com/api/docker/container-links/550e8400-e29b-41d4-a716-446655440000/runtime \
  --header 'Authorization: Bearer <token>'

The link and its relay counters summed over its routes (one per consumer node). A link whose ends share a node runs without the relay and reports no relay traffic.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful response

application/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

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

application/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

application/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

application/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

application/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

application/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

application/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

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