Skip to content
Omniglass Omniglass Omniglass

Create a severity level

POST
/severity-levels
 
curl --request POST \
  --url https://example.com/api/v1/severity-levels \
  --header 'Content-Type: application/json' \
  --data '{ "color": "example", "label": "example", "name": "example", "rank": 1 }'

Adds an operator severity level at a rank of its own, between two others without renumbering. A name or rank already taken is a 409; a color outside the palette is a 422. Audited. Gated by severity_level:create, with an all-scope grant: a level’s rank moves health fleet-wide.

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

One of gray, blue, green, yellow, orange, red, darkred

string
label

A human label

string
name
required

The level’s name (lowercase kebab)

string
>= 1 characters
rank
required

Its place among the levels: higher is more severe; unique

integer format: int64

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
color
required

The hue the console renders the level in

string
Allowed values: gray blue green yellow orange red darkred
id
required

The level’s uuid, the stable form of name

string
label
string
name
required

The level’s name; alarms and rules name it

string
official
required

Shipped with the platform and read-only

boolean
outage
required

Whether an active alarm at this level puts its component in outage (at or above the high level’s rank); below it, an alarm degrades

boolean
rank
required

Compares levels: higher is more severe

integer format: int64
Example 
{
  "$schema": "/api/v1/schemas/SeverityLevelBody.json",
  "color": "gray"
}

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