v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB

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

The host this entity belongs to.

namestring required

Human-facing name for the service.

network_idstring uuid required

The network this entity belongs to.

positioninteger required

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

service_definitionstring required

Which known software this service is, if identified.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

first_discovery_idstring uuid nullable

The discovery that first observed this entity.

idstring uuid required

Server-assigned unique identifier.

last_discovery_idstring uuid nullable

The most recent discovery that observed this entity.

last_seen_atstring date-time

When a discovery last observed this entity.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Example request

{
  "bindings": [
    {
      "created_at": "2026-07-29T15:23:06.660341Z",
      "first_discovery_id": null,
      "id": "999dbf39-0357-4b20-8bd8-cc20520334ea",
      "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
      "last_discovery_id": null,
      "last_seen_at": "2026-07-29T15:23:06.660341Z",
      "lineage_id": null,
      "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-07-29T15:23:06.660341Z",
      "valid_from": "2026-07-29T15:23:06.660341Z",
      "valid_to": null
    }
  ],
  "created_at": "2026-01-15T10:30:00Z",
  "first_discovery_id": null,
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440007",
  "last_discovery_id": null,
  "last_seen_at": "2026-01-15T10:30:00Z",
  "lineage_id": null,
  "name": "nginx",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "position": 0,
  "service_definition": "Unclaimed Open Ports",
  "source": {
    "type": "Manual"
  },
  "tags": [],
  "updated_at": "2026-01-15T10:30:00Z",
  "valid_from": "2026-01-15T10:30:00Z",
  "valid_to": null,
  "virtualization": null
}

Response

Service updated

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "data": {
    "bindings": [
      {
        "created_at": "2026-07-29T15:23:06.668616Z",
        "first_discovery_id": null,
        "id": "7ad6de19-781d-4c36-b3a6-426ca0d47007",
        "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
        "last_discovery_id": null,
        "last_seen_at": "2026-07-29T15:23:06.668616Z",
        "lineage_id": null,
        "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-07-29T15:23:06.668616Z",
        "valid_from": "2026-07-29T15:23:06.668616Z",
        "valid_to": null
      }
    ],
    "created_at": "2026-01-15T10:30:00Z",
    "first_discovery_id": null,
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440007",
    "last_discovery_id": null,
    "last_seen_at": "2026-01-15T10:30:00Z",
    "lineage_id": null,
    "name": "nginx",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "position": 0,
    "service_definition": "Unclaimed Open Ports",
    "source": {
      "type": "Manual"
    },
    "tags": [],
    "updated_at": "2026-01-15T10:30:00Z",
    "valid_from": "2026-01-15T10:30:00Z",
    "valid_to": null,
    "virtualization": null
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}