Create host
Creates a host with optional ip_addresses, ports, and services.
The source field is automatically set to Manual.
Tag Validation
- Tags must exist and belong to your organization
- Duplicate tag UUIDs are automatically deduplicated
- Invalid or cross-organization tag UUIDs return a 400 error
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 host with its associated ip_addresses, ports, and services.
Server assigns host_id, site_id, and source to all children.
Client must provide UUIDs for all entities, enabling services to reference
ip_addresses/ports by ID in the same request.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/hosts" \ -H "Content-Type: application/json" \ -d '{ "credential_assignments": [], "description": "Primary web server", "hostname": "web-server-01.local", "interfaces": [], "ip_addresses": [ { "id": "550e8400-e29b-41d4-a716-446655440005", "ip_address": "192.168.1.100", "mac_address": "DE:AD:BE:EF:12:34", "name": "eth0", "position": 0, "subnet_id": "550e8400-e29b-41d4-a716-446655440004" } ], "name": "web-server-01", "ports": [ { "id": "550e8400-e29b-41d4-a716-446655440006", "number": 80, "protocol": "Tcp" } ], "services": [ { "bindings": [ { "id": "550e8400-e29b-41d4-a716-446655440009", "ip_address_id": "550e8400-e29b-41d4-a716-446655440005", "port_id": "550e8400-e29b-41d4-a716-446655440006", "type": "Port" } ], "id": "550e8400-e29b-41d4-a716-446655440007", "name": "nginx", "position": 0, "service_definition": "Grafana", "tags": [], "virtualization_metadata": null, "virtualization_service_id": null } ], "site_id": "550e8400-e29b-41d4-a716-446655440002", "tags": [], "virtualization_interface_id": null, "virtualization_metadata": null, "virtualization_service_id": null }'{
"meta": {
"api_version": 1,
"server_version": "0.19.6"
},
"success": true,
"data": {
"asset_tag": "IT-00412",
"asset_tag_source": {
"Probe": "Snmp"
},
"chassis_id_source": "Unspecified",
"created_at": "2026-01-15T10:30:00Z",
"credential_assignments": [],
"description": "Primary web server",
"device_type": "Server",
"device_type_source": {
"service_id": "550e8400-e29b-41d4-a716-446655440007",
"service_name": "nginx",
"type": "Service"
},
"dismissed_at": null,
"display_name": "web-server-01",
"display_name_rung": "Name",
"firmware_revision": null,
"firmware_revision_source": "Unspecified",
"first_discovery_id": null,
"found_by_discovery_id": null,
"hidden": false,
"hostname": "web-server-01.local",
"hostname_source": "Manual",
"id": "550e8400-e29b-41d4-a716-446655440003",
"interfaces": [
{
"admin_status": "Up",
"created_at": "2026-01-15T10:30:00Z",
"display_name": "Uplink to Core Switch",
"first_discovery_id": null,
"host_id": "550e8400-e29b-41d4-a716-446655440003",
"id": "550e8400-e29b-41d4-a716-44665544000f",
"if_alias": "Uplink to Core Switch",
"if_descr": "GigabitEthernet0/1",
"if_index": 1,
"if_name": "Gi0/1",
"if_type": 6,
"interface_source": {
"Probe": "Snmp"
},
"ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
"ip_configured": true,
"last_discovery_id": null,
"last_seen_at": "2026-01-15T10:30:00Z",
"lineage_id": null,
"mac_address": "DE:AD:BE:EF:CA:FE",
"mac_address_source": "ArpReply",
"neighbor_candidates": [],
"oper_status": "Up",
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"speed_bps": 1000000000,
"updated_at": "2026-01-15T10:30:00Z",
"valid_from": "2026-01-15T10:30:00Z",
"valid_to": null,
"vlan_membership_source": "Unspecified"
}
],
"ip_addresses": [
{
"created_at": "2026-01-15T10:30:00Z",
"first_discovery_id": null,
"host_id": "550e8400-e29b-41d4-a716-446655440003",
"id": "550e8400-e29b-41d4-a716-446655440005",
"ip_address": "192.168.1.100",
"ip_address_source": "ArpReply",
"last_discovery_id": null,
"last_seen_at": "2026-01-15T10:30:00Z",
"lineage_id": null,
"mac_address": "DE:AD:BE:EF:CA:FE",
"mac_address_source": "ArpReply",
"name": "eth0",
"position": 0,
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"subnet_id": "550e8400-e29b-41d4-a716-446655440004",
"updated_at": "2026-01-15T10:30:00Z",
"valid_from": "2026-01-15T10:30:00Z",
"valid_to": null
}
],
"last_discovery_id": null,
"last_seen_at": "2026-01-15T10:30:00Z",
"management_url_source": "Unspecified",
"manufacturer_source": "Unspecified",
"model_source": "Unspecified",
"name": "web-server-01",
"name_ladder": [
{
"rung": "Name",
"source": "Manual",
"value": "web-server-01"
},
{
"rung": "Hostname",
"source": "Manual",
"value": "web-server-01.local"
},
{
"rung": "SysName",
"source": null,
"value": null
},
{
"rung": "ChassisId",
"source": null,
"value": null
},
{
"rung": "Address",
"source": null,
"value": "192.168.1.100"
}
],
"name_source": "Manual",
"os": null,
"os_source": "Unspecified",
"ports": [
{
"created_at": "2026-01-15T10:30:00Z",
"first_discovery_id": null,
"host_id": "550e8400-e29b-41d4-a716-446655440003",
"id": "550e8400-e29b-41d4-a716-446655440006",
"last_discovery_id": null,
"last_seen_at": "2026-01-15T10:30:00Z",
"lineage_id": null,
"number": 80,
"port_source": "PortScan",
"protocol": "Tcp",
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"type": "Http",
"updated_at": "2026-01-15T10:30:00Z",
"valid_from": "2026-01-15T10:30:00Z",
"valid_to": null
}
],
"reported_by_host_ids": [],
"serial_number_source": "Unspecified",
"services": [
{
"bindings": [
{
"created_at": "2026-11-03T22:25:05.928198Z",
"first_discovery_id": null,
"id": "0919bf2a-3a9e-4e1c-b39d-1b554b80b63b",
"ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
"last_discovery_id": null,
"last_seen_at": "2026-11-03T22:25:05.928198Z",
"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.928198Z",
"valid_from": "2026-11-03T22:25:05.928198Z",
"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
}
],
"site_id": "550e8400-e29b-41d4-a716-446655440002",
"software_revision": null,
"software_revision_source": "Unspecified",
"source": {
"type": "Manual"
},
"sys_contact_source": "Unspecified",
"sys_descr_source": "Unspecified",
"sys_location_source": "Unspecified",
"sys_name_source": "Unspecified",
"sys_object_id_source": "Unspecified",
"tags": [],
"updated_at": "2026-01-15T10:30:00Z",
"virtualization_depth": 0,
"virtualization_interface_id": null,
"virtualization_metadata": null,
"virtualization_parent_host_id": null,
"virtualization_root_host_id": 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
}
}{
"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.
Confirm unconfirmed host
Records that a person vouches for a host Scanopy knows only from another device's report (an LLDP/CDP neighbour, or a switch's forwarding table). The host's source becomes `Manual`.
Dismiss unconfirmed host
Sets aside a host Scanopy knows only from another device's report. It leaves lists, topology and scan warnings, and is not created again by later scans. A scan that reaches the device restores it.