Locations

Create a location

Create a Private Location.

post/locations

Request

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

Request body

namestring required

The name of the location.

sshPublicKeystring required

The SSH public key of the location.

Example request

{
  "name": "location1",
  "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.

runCommandstring

Command to start the location agent locally. The hosted MCP never runs this command.

Changes

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