Skip to main content
PATCH
/
org
/
{org}
/
location
/
{name}
Patch
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/location/{name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "origin": "default",
  "provider": "aws",
  "region": "<string>",
  "spec": {
    "enabled": true
  }
}
'
{
  "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",
  "provider": "aws",
  "region": "<string>",
  "spec": {
    "enabled": true
  },
  "status": {
    "geo": {
      "lat": 123,
      "lon": 123,
      "country": "<string>",
      "state": "<string>",
      "city": "<string>",
      "continent": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
name
string
required

Body

application/json
name
string
Maximum string length: 64
description
string
tags
object
origin
enum<string>
default:default
Available options:
builtin,
default
provider
enum<string>
Available options:
aws,
gcp,
azure
region
string
spec
object

Response

Success

id
string
name
string
Maximum string length: 64
kind
string
version
integer
description
string
tags
object
created
string<date-time>
lastModified
string<date-time>
origin
enum<string>
default:default
Available options:
builtin,
default
provider
enum<string>
Available options:
aws,
gcp,
azure
region
string
spec
object
status
object