Skip to content
Omniglass Omniglass Omniglass

Update a location

PATCH
/locations/{name}
 
curl --request PATCH \
  --url https://example.com/api/v1/locations/example \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "location_type": "example", "name": "example", "parent": "example" }'

Patches a location’s display_name, location_type, or parent (a move). Gated by location:update; the read and update scopes drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
display_name
string
location_type
string
name

A new globally unique technical name (rename)

string
>= 1 characters <= 100 characters /^[a-z0-9][a-z0-9-]*$/
parent

Re-parents the location (a tree move) to this location name, cycle-guarded and placement-validated. Moving to root is not supported via update this slice.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type 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
id
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

Section titled “default ”

Error

Media type 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"
}