Search Available Sites

GET 
/networking/search/sites

Search for available sites to deploy your network to.

Request

Query Parameters

filter[region_id] numberrequired

The id of the region you want to filter on

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id stringrequired

The id of the site

name stringrequired

The name of the site

description stringrequired

The description of the site

local_cloud_regions

object[]

required

Array [

cloud_provider stringrequired

Cloud provider

cloud_region stringrequired

Cloud region

]

record_type stringrequired

The type of record being returned. This will always be site.

]

meta

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

{
  "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
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Loading...