List Resources

get/resources

Query parameters

limitinteger

Limit Resources returned

page_cursorstring

Next/Prev page cursor

namestring

Filter to Resources with this exact name

typestring

Filter to Resources of this type: cidr, ip, dns, or static_device_pool.

site_idstring

Filter to Resources connected to this Site

addressstring

Filter to Resources with this exact address

ip_stackstring

Filter to Resources with this exact ip_stack

Response

Resource Response

Example response

{
  "data": [
    {
      "address": "10.0.0.10",
      "address_description": "Production Database",
      "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
      "name": "Prod DB",
      "site_id": "0642e09d-b3a2-47e4-9cd1-c2195faeeb67",
      "type": "ip"
    },
    {
      "address": "10.0.0.20",
      "address_description": "Production Admin Dashboard",
      "id": "3b9451c9-5616-48f8-827f-009ace22d015",
      "name": "Admin Dashboard",
      "site_id": "0642e09d-b3a2-47e4-9cd1-c2195faeeb67",
      "type": "ip"
    }
  ],
  "metadata": {
    "limit": 10,
    "next_page": "98776234123",
    "prev_page": "123123425",
    "total": 100
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.