Sign in
Bindings

Create a new Binding

Creates a binding that associates a service with a port or interface.

Binding Types

  • Interface binding: Service is present at an interface (IP address) without a specific port. Used for non-port-bound services like gateways.
  • Port binding (specific ip_address): Service listens on a specific port on a specific interface.
  • Port binding (all ip_addresses): Service listens on a specific port on all ip_addresses (ip_address_id: null).

Validation and Deduplication Rules

  • Conflict detection: Interface bindings conflict with port bindings on the same interface. A port binding on all ip_addresses conflicts with any interface binding for the same service.
  • All-interfaces precedence: When creating a port binding with ip_address_id: null, any existing specific-interface bindings for the same port are automatically removed, as they are superseded by the all-interfaces binding.
post/api/v1/bindings

Request body

OR

Example request

{
  "created_at": "2026-05-01T19:08:39.690239Z",
  "id": "d4f17a47-8bee-4567-90eb-1c57731a8ed5",
  "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "port_id": "550e8400-e29b-41d4-a716-446655440006",
  "service_id": "550e8400-e29b-41d4-a716-446655440007",
  "type": "Port",
  "updated_at": "2026-05-01T19:08:39.690239Z"
}

Response

Binding created (superseded bindings may be removed)

errorstring nullable
successboolean required

Example response

{
  "data": {
    "created_at": "2026-05-01T19:08:39.709697Z",
    "id": "100ce23b-6c43-44c4-8c99-171396c38567",
    "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "port_id": "550e8400-e29b-41d4-a716-446655440006",
    "service_id": "550e8400-e29b-41d4-a716-446655440007",
    "type": "Port",
    "updated_at": "2026-05-01T19:08:39.709697Z"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.16.2"
  }
}

Changes