Skip to content
Omniglass Omniglass Omniglass

Rename a system

POST
/systems/{name}:rename
 
curl --request POST \
  --url https://example.com/api/v1/systems/example:rename \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Moves the system’s name, the address an operator types and every external reference stores. A separate act from an update, and a separately grantable one, because it breaks bookmarks, runbooks, and integration config outside this system; inside it nothing breaks, since every reference holds the uuid. A taken name is a 409, an illegal or uuid-shaped one a 422. Gated by system:rename; read and rename scopes drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The system’s current name, a dotted address, or its uuid

string

The system’s current name, a dotted address, or its uuid

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
name
required

The new name, unique within its placement (lowercase letters, digits, hyphens)

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

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
effective_tags

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

object
key
additional properties
string
id
required
string
label
string
label_generated
required

Whether the platform rendered this label from a label rule rather than an operator typing it. Read-only: write label to claim it, write an empty label to hand it back.

boolean
location

The location’s name, for display

string
location_id

The location’s id, the canonical handle

string
member_count
required

How many components are bound into this system

integer format: int64
name
required
string
name_generated
required

Whether the platform picked this name (from the system_type’s stem) rather than an operator typing it.

boolean
parent

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

string
parent_id

The parent system’s id, the canonical handle

string
path

The dotted address (e.g. boi.17c.$sys.av). Set on a GET or LIST response; empty on a create/update/move/rename response (refetch the row to see it).

string
path_segments

Path split on ’.’, accessors included, so the round trip through the resolver stays lossless.

Array<string> | null
renders

Two display-only compact forms of path, dash and bare. Neither is accepted back by the resolver: stripping/compacting is lossy.

object
bare
required

The dash render’s segments concatenated with no separator, with the final stem-ordinal segment compacted to when the owning type registers one (e.g. boi17c216bdsp1). On a LIST row the substitution is skipped (segments concatenated as-is) to avoid a per-row abbrev resolution; a GET always compacts it. Display only either way; not accepted by the resolver.

string
dash
required

The path’s non-accessor segments joined with ’-’ (e.g. boi-17c-216b-display-1). Display only; not accepted by the resolver.

string
standard

The standard’s handle, for display; omitted for a one-off system

string
standard_id

The standard’s uuid; the stable form of standard

string
system_type

The system_type’s name, for display: what kind of space this is (board, class, video-wall). Omitted for an unclassified system. Distinct from standard, which is the blueprint it is built to.

string
system_type_id

The system_type’s uuid; the stable form of system_type

string
Example 
{
  "$schema": "/api/v1/schemas/SystemBody.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"
}