ScanopyScanopy
Hosts

List all hosts

Returns all hosts the authenticated user has access to, with their interfaces, ports, and services included. Supports pagination via limit and offset query parameters.

GET
/api/v1/hosts
Authorization<token>

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

In: header

Query Parameters

network_id?string|null

Filter by network ID

Formatuuid
limit?integer|null

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

Formatint32
Range0 <= value <= 1000
offset?integer|null

Number of results to skip. Default: 0.

Formatint32
Range0 <= value

Response Body

application/json

curl -X GET "https://loading/api/v1/hosts"
{
  "data": [
    {
      "created_at": "2026-01-15T10:30:00Z",
      "description": "Primary web server",
      "hidden": false,
      "hostname": "web-server-01.local",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "interfaces": [
        {
          "created_at": "2026-01-15T10:30:00Z",
          "host_id": "550e8400-e29b-41d4-a716-446655440003",
          "id": "550e8400-e29b-41d4-a716-446655440005",
          "ip_address": "192.168.1.100",
          "mac_address": "DE:AD:BE:EF:12:34",
          "name": "eth0",
          "network_id": "550e8400-e29b-41d4-a716-446655440002",
          "position": 0,
          "subnet_id": "550e8400-e29b-41d4-a716-446655440004",
          "updated_at": "2026-01-15T10:30:00Z"
        }
      ],
      "name": "web-server-01",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "ports": [
        {
          "created_at": "2026-01-15T10:30:00Z",
          "host_id": "550e8400-e29b-41d4-a716-446655440003",
          "id": "550e8400-e29b-41d4-a716-446655440006",
          "network_id": "550e8400-e29b-41d4-a716-446655440002",
          "number": 80,
          "protocol": "Tcp",
          "type": "Http",
          "updated_at": "2026-01-15T10:30:00Z"
        }
      ],
      "services": [],
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z",
      "virtualization": null
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.13.2"
  },
  "success": true,
  "error": "string"
}