Create service
Creates a service with optional bindings to ip_addresses or ports.
The id, created_at, updated_at, and source fields are generated server-side.
Bindings are specified without service_id or site_id - these are assigned automatically.
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 in the same request 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. A port binding on all ip_addresses conflicts with any interface binding.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request type for creating a service.
Server assigns id, created_at, updated_at, and source.
Server also assigns service_id and site_id to all bindings.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/services" \ -H "Content-Type: application/json" \ -d '{ "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b", "name": "string", "service_definition": "string", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "tags": [ "a424dc99-d215-4281-ad2d-a3a9bc179925" ] }'{
"meta": {
"api_version": 1,
"server_version": "0.19.6"
},
"success": true,
"data": {
"bindings": [
{
"created_at": "2026-11-03T22:25:05.952454Z",
"first_discovery_id": null,
"id": "b63edd33-174e-4252-8e2e-dbde5cf6aecb",
"ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
"last_discovery_id": null,
"last_seen_at": "2026-11-03T22:25:05.952454Z",
"lineage_id": null,
"port_id": "550e8400-e29b-41d4-a716-446655440006",
"service_id": "550e8400-e29b-41d4-a716-446655440007",
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"type": "Port",
"updated_at": "2026-11-03T22:25:05.952454Z",
"valid_from": "2026-11-03T22:25:05.952454Z",
"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",
"position": 0,
"service_definition": "Grafana",
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"source": {
"type": "Manual"
},
"tags": [],
"updated_at": "2026-01-15T10:30:00Z",
"valid_from": "2026-01-15T10:30:00Z",
"valid_to": null,
"virtualization_metadata": null,
"virtualization_service_id": null
},
"error": "string"
}{
"meta": {
"api_version": 1,
"server_version": "0.19.6"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}Product names and logos are trademarks of their respective owners. See credits.
Bulk delete services
Previous Page
Update 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.