ScanopyScanopy
Bindings

Update a Binding

Updates an existing binding. The same conflict detection rules from binding creation apply.

Validation Rules

  • Conflict detection: The updated binding must not conflict with other bindings on the same service. Interface bindings conflict with port bindings on the same interface.
PUT
/api/v1/bindings/{id}

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Path Parameters

id*string

Binding ID

Formatuuid

Request Body

application/json

ip_address_id*string
Formatuuid
network_id*string
Formatuuid
service_id*string
Formatuuid
type*string
Value in"IPAddress"

Response Body

application/json

application/json

application/json

curl -X PUT "https://loading/api/v1/bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "created_at": "2026-04-20T04:23:43.712215Z",    "id": "a76d2998-7ed3-4b40-a34d-ccd907a273ef",    "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-04-20T04:23:43.712215Z"  }'
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "created_at": "2026-04-20T04:23:43.728453Z",
    "id": "554a49fc-2521-4955-afa1-86e03952bed6",
    "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-04-20T04:23:43.728453Z"
  },
  "error": "string"
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

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.

Delete Binding

Next Page