Get a location

GET

/locations/{name}

const url = 'https://example.com/api/v1/locations/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/locations/example

Fetches a location by name within the caller’s read scope. Out of scope is a non-disclosing 404. Gated by location:read.

Parameters

Path Parameters

name

required

The location’s unique name

string

The location’s unique name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

actions

The scope-aware actions the caller may perform on this row (create a child, update, delete); a UI hint, the server still enforces.

Array<string> | null

display_name

string

effective_tags

The resolved effective tags (key -> winning value) that cascade onto this location (platform and its location tree); for the Tags column.

object

key

additional properties

string

required

string

location_type

required

The location_type name

string

location_type_id

required

The location_type’s uuid, the stable form of location_type

string

name

required

string

parent

The parent location’s name, for display; absent for a site root

string

parent_id

The parent location’s id, the canonical handle

string

Example

{
  "$schema": "/api/v1/schemas/LocationBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}