Get a location

get

https://platform.reactvision.xyz/functions/v1/vps/locations/{location_id}

Client or secret key. Scope: vps.

Also accepts a user token.

Returns a location with its active scan, whose map apps localise against.

A client or legacy key sees the project's shared locations only. A secret key sees every location of the project, or, with x-app-user-id, that app user's and the shared ones; a user token sees its app user's and the shared ones. Any other location answers 404 NOT_FOUND, the same as one that does not exist.

Not counted against the monthly API request quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

`MISSING_PROJECT_ID`: no `x-project-id` header.

`INVALID_PROJECT_ID`: `x-project-id` is not a UUID.

`INVALID_APP_USER_ID`: `x-app-user-id` is not 1 to 255 printable ASCII characters without spaces, or is `.` or `..`.

`MISSING_API_KEY`: no `x-api-key` header and no user token.

`INVALID_API_KEY_FORMAT`: the key is not `rv_live_`, `rv_client_` or `rv_secret_` followed by 64 lowercase hexadecimal characters.

`INVALID_SESSION_FORMAT`: the `Authorization` header is not `Bearer` followed by a user token.

`INVALID_API_KEY`: no such key, or a key sent with the wrong prefix for its type.

`API_KEY_EXPIRED`: the key is past its expiry date.

`INVALID_APP_USER_TOKEN`: the user token is not valid, or the secret key that minted it has been deleted or has expired.

`APP_USER_TOKEN_EXPIRED`: the user token has expired. Get a new one from your backend.

`INVALID_SESSION`: a Bearer token that is neither a user token nor a ReactVision Editor session.

Get a location

`MISSING_PROJECT_ID`: no `x-project-id` header.

`INVALID_PROJECT_ID`: `x-project-id` is not a UUID.

`INVALID_APP_USER_ID`: `x-app-user-id` is not 1 to 255 printable ASCII characters without spaces, or is `.` or `..`.

`NOT_FOUND`: no such location, or one the request cannot see.

`RATE_LIMITED`: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`AUTH_UNAVAILABLE`: the key or user token could not be checked. Retry; this does not mean it is invalid.

`VPS_LOOKUP_FAILED`: the records could not be read or written. Retry.

200The location.

400MISSING_PROJECT_ID: no x-project-id header. INVALID_PROJECT_ID: x-project-id is not a UUID. INVALID_APP_USER_ID: x-app-user-id is not 1 to 255 printable ASCII characters without spaces, or is . or ...

404NOT_FOUND: no such location, or one the request cannot see.

429RATE_LIMITED: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

500INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.

503AUTH_UNAVAILABLE: the key or user token could not be checked. Retry; this does not mean it is invalid. VPS_LOOKUP_FAILED: the records could not be read or written. Retry.

`MISSING_PROJECT_ID`: no `x-project-id` header.

`INVALID_PROJECT_ID`: `x-project-id` is not a UUID.

`INVALID_APP_USER_ID`: `x-app-user-id` is not 1 to 255 printable ASCII characters without spaces, or is `.` or `..`.

`NOT_FOUND`: no such location, or one the request cannot see.

`RATE_LIMITED`: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`AUTH_UNAVAILABLE`: the key or user token could not be checked. Retry; this does not mean it is invalid.

`VPS_LOOKUP_FAILED`: the records could not be read or written. Retry.