Sites V1

Site operations

Search Available Sites

Search for available sites to deploy your network to.

SecuritybasicAuth or bearerAuth
Request
query Parameters
filter[region_id]
required
number

The id of the region you want to filter on

Responses
200

Successful response

Response Schema: application/json
Array of objects (Site)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

get/networking/search/sites
Request samples
Response samples
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "name": "string",
      • "description": "string",
      • "local_cloud_regions": [
        • {
          • "cloud_provider": "string",
          • "cloud_region": "string"
          }
        ],
      • "record_type": "string"
      }
    ],
  • "meta": {
    • "total_pages": 13,
    • "total_results": 13,
    • "page_number": 3,
    • "page_size": 1
    }
}