Get a location by name

Response will contain the requested location if the caller is authorized to view it

GET /org/{org}/location/{name}

Get a location by name

cURL

curl --request GET \
  --url https://api.cpln.io/org/{org}/location/{name} \
  --header 'Authorization: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "version": 123,
  "description": "<string>",
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "origin": "default",
  "region": "<string>",
  "spec": {
    "enabled": true
  },
  "status": {
    "geo": {
      "lat": 123,
      "lon": 123,
      "country": "<string>",
      "state": "<string>",
      "city": "<string>",
      "continent": "<string>"
    },
    "ipRanges": [
      "<string>"
    ]
  }
}

Authorizations

serviceAccountKeyjwt

Authorization · string · header · required

Service account key can be used as API keys

Path Parameters

org · string · required

name · string · required

Response

200

application/json

Success

id · string · read-only

name · string

Maximum string length: 64

kind · string · read-only

version · integer · read-only

description · string

Maximum string length: 250

tags · object

created · string<date-time> · read-only

lastModified · string<date-time> · read-only

links · object[] · read-only

Show child attributes

origin · enum<string> · default: default · read-only

Available options: builtin, default, custom

provider · enum<string>

Available options: aws, gcp, azure, byok, linode, vultr, equinix, oci

region · string

spec · object

Show child attributes

status · object · read-only

Show child attributes