Sign in
Services

Update a service

Updates an existing service. All binding validation rules from service creation apply here as well.

Binding Validation Rules

  • Cross-host validation: All bindings must reference ports/interfaces that belong to the service's host. Bindings referencing entities from other hosts will be rejected.
  • Deduplication: Duplicate bindings are automatically deduplicated.
  • All-interfaces precedence: If a port binding with ip_address_id: null (all ip_addresses) is included, any specific-interface bindings for the same port are automatically removed.
  • Conflict detection: Interface bindings conflict with port bindings on the same interface.
put/api/v1/services/{id}

Path parameters

idstring uuid required

Service ID

Request body

host_idstring uuid required
namestring required
network_idstring uuid required
positioninteger required

Position of this service in the host's service list (for ordering)

service_definitionstring required
tagsstring[] required
created_atstring date-time required
idstring uuid required
updated_atstring date-time required

Example request

{
  "bindings": [
    {
      "created_at": "2026-04-20T04:23:43.712081Z",
      "id": "8e7faba1-f325-42db-a982-c7d70a90d0d7",
      "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.712081Z"
    }
  ],
  "created_at": "2026-01-15T10:30:00Z",
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440007",
  "name": "nginx",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "position": 0,
  "service_definition": "APC",
  "source": {
    "type": "Manual"
  },
  "tags": [],
  "updated_at": "2026-01-15T10:30:00Z",
  "virtualization": null
}

Response

Service updated

errorstring nullable
successboolean required

Example response

{
  "data": {
    "bindings": [
      {
        "created_at": "2026-04-20T04:23:43.723772Z",
        "id": "7a60015a-2114-4bef-bd4c-dbdfb7737b4e",
        "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.723772Z"
      }
    ],
    "created_at": "2026-01-15T10:30:00Z",
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440007",
    "name": "nginx",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "position": 0,
    "service_definition": "APC",
    "source": {
      "type": "Manual"
    },
    "tags": [],
    "updated_at": "2026-01-15T10:30:00Z",
    "virtualization": null
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  }
}

Changes