ESescape
Locations

Update a location

Update a Private Location details. Location names are immutable and cannot be changed.

put/locations/{locationId}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

locationIdstring uuid required

The ID of the location to update

Example:00000000-0000-0000-0000-000000000000

Request body

namestring

Deprecated. Location names are immutable and this field is ignored if provided.

enabledboolean

Whether the location is enabled.

sshPublicKeystring

The SSH public key of the location.

Example request

{
  "name": "location1",
  "enabled": true,
  "sshPublicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl"
}

Response

OK

idstring uuid

The location ID.

namestring

The name of the location.

typestring

The type of the location.

enabledboolean

Whether the location is enabled.

createdAtstring

The date and time the location was created.

lastSeenAtstring nullable

The date and time the location was last seen.

ipstring nullable

The IP address of the location.

region'Asia' | 'Canada' | 'Europe' | 'UnitedStates' | 'null' nullable

The region of the location.

isActiveboolean

Whether the location agent is currently active.

Changes

No recorded changes to this operation across all 1 revision of this API.