This section outlines the key attributes of the location's API object. This object can be utilized through the API, CLI and the console's apply functionality.

id string

name string

Max Length: 64

kind string

version integer

description string

Max Length: 250

tags object

created string

Format: date-time

lastModified string

Format: date-time

links array of objects - See Below

origin string

Default: default

Possible enum values:

  • builtin

  • default

  • custom

provider string

Possible enum values:

  • aws

  • gcp

  • azure

  • byok

  • linode

  • vultr

  • equinix

region string

spec object - See Below

status object - See Below

rel string

href string


enabled boolean


geo object - See Below

ipRanges array of strings


lat number

lon number

country string

state string

city string

continent string

Copyright © 2024 Control Plane Corporation. All rights reserved. Revision ba5c0f81