List Provider Locations

Fetch the list of provider locations where Cycle can deploy servers.

query
  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns a list of provider location resources, otherwise returns an Error.

  • id
    string

    The ID of the provider location.

  • name
    string

    The name of this provider location.

  • geographic
    object | null

    Geographic information about this location.

    Show child fields
  • provider
    object

    A summary of the provider this location is associated with.

    Show child fields
  • compatible
    bool

    If true, this location is compatible with Cycle.

  • features
    object

    Unique features available at this location.

    Show child fields
  • abbreviation
    string

    An abbreviated identifier for this location.

  • annotations
    object

    An object containing extra information about the location, such as specific provider features.

GET /v1/infrastructure/providers/{identifier}/locations

Example Request
$ curl https://api.cycle.io/v1/infrastructure/providers/equinix-metal/locations \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-Hub-Id: HUB_ID"
Example Response
{
"data": [
{
"id": "5c1ab90821638910ec95558a",
"name": "Sunnyvale, CA",
"geographic": null,
"provider": {
"identifier": "equinix-metal",
"location": "2b70eb8f-fa18-47c0-aba7-222a842362fd",
"code": "sjc1"
},
"compatible": true,
"features": {
"available": [],
"supported": []
},
"abbreviation": "sjc1",
"annotations": {
"ami": "32423424234234"
}
}
]
}