Skip to content
Omniglass
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Architecture
Why Omniglass
Design
Overview
Design
Implementation status
Decision log
Roadmap
Core entities
Partial
Templates
Design
Data collection
Partial
Datapoints
Partial
Events
Design
Calculations
Design
Config & credentials
Partial
Cascade
Partial
Groups
Design
Health & KPIs
Partial
Alarms and actions
Partial
UI
Partial
Views
Design
API
Partial
Messaging
Design
Nodes
Partial
Storage
Partial
Workers
Design
Scaling and deployment
Partial
Settings
Partial
Time
Design
Identity and access
Partial
Audit
Partial
Files and blobs
Partial
AI
Design
Expressions
Design
Glossary
Design
Contributing
API first
Test-driven
Docs with everything
Learning tool
Primitive first
Design system
Slice workflow
Release and CI
Labels
Operator guide
Overview
Sign in and your profile
Find things in your estate
Work with an entity
Nodes and reachability
The CLI
Admin guide
Overview
Manage users
Roles, groups, and grants
The audit trail
Secrets
Variables
Files
Types
Properties
Tags
Vendors
Drivers
Capabilities
Products
Standards
Deployment
Overview
Install
Container image
Deploying with Helm
PR preview environments
Reference
CLI
API reference
Overview
Operations
List audit-trail events
Log in with a username and password
Log out the current session
The authenticated principal, its permissions, and grants
Update your own profile
Get your own profile picture
List your own sessions and tokens
Revoke one of your own sessions
Revoke all of your own sessions or tokens
Create one of your own API tokens
Change your own password
Remove your own profile picture
Set your own profile picture
Stop the current impersonation session
Whether the system has an owner yet
List capabilities
Create a capability
Get a capability
Delete a capability
Update a capability
List components in scope
Create a component
Get a component
Delete a component
Update a component
List a component's alarms
Raise an alarm on a component
Clear an alarm
List a component's effective capabilities
Declare a capability on a component
Clear a capability declaration on a component
Effective secrets for a component
Effective tags for a component
Effective variables for a component
List a component's recent events
List the systems a component is in
List a component's effective properties
Set a property on a component
Clear a property on a component
Read a component's per-interface reachability
List tags on a component
Remove a tag value from a component
Set a tag value on a component
Check a component technical name
List drivers
Create a driver
Get a driver
Delete a driver
Update a driver
List files
Create a file from an upload
Get a file's metadata
Delete a file
Download a file's bytes
Liveness and database-reachability probe
List interfaces in scope
Create an interface
Get an interface
Delete an interface
Update an interface
List location types
Create a location type
Delete a location type
Update a location type
List a location type's declared properties
Declare a property on a location type
Withdraw a property from a location type
List locations in scope
Create a location
Get a location
Delete a location
Update a location
Read a location's health
List a location's effective properties
Set a property on a location
Clear a property on a location
List tags on a location
Remove a tag value from a location
Set a tag value on a location
Check a location technical name
List nodes
Create a node
Get a node
Delete a node
Update a node
Mint a node's enrollment token
List tags on a node
Remove a tag value from a node
Set a tag value on a node
Claim a node identity in exchange for its NATS credential
List principal groups
Create a principal group
Get a principal group
Delete a principal group
Update a principal group
List a group's grants
Grant a role to a group
Revoke a group grant
List a group's members
Add a member to a group
Remove a member from a group
List principals
Create a human principal
Get a principal
Update a principal
Get a principal's profile picture
Grant a role to a principal
Revoke a grant
List a principal's sessions
Revoke a principal's session
Revoke all of a principal's sessions or tokens
Archive a principal
Disable a principal
Enable a principal
Impersonate a principal (view-as or act-as)
Purge a principal
Remove a principal's profile picture
Reset a principal's password
Restore a principal
Set a principal's profile picture
List products
Create a product
Get a product
Delete a product
Update a product
List a product's declared properties
Declare a property on a product
Withdraw a property from a product
List properties
Create a property
Get a property
Delete a property
Update a property
List roles
List secret types
List secrets
Create a secret
Delete a secret
Update a secret's field values
Decrypt a secret for clipboard copy
Reveal a secret's plaintext
Get effective settings with provenance
Get the caller's effective settings
Restore a settings namespace to defaults
Update a settings namespace
Restore all settings to defaults
List standards
Create a standard
Get a standard
Delete a standard
Update a standard
List a standard's declared properties
Declare a property on a standard
Withdraw a property from a standard
List a standard's declared roles
Declare a role on a standard
Withdraw a role from a standard
List systems in scope
Create a system
Get a system
Delete a system
Update a system
Read a system's health
List the components in a system
Put a component in a system
Take a component out of a system
Make this the component's default system
List a system's effective properties
Set a property on a system
Clear a property on a system
List a system's effective roles
Declare a role on a system
Withdraw a role from a system
Assign a component to a role
Unassign a component from a role
List tags on a system
Remove a tag value from a system
Set a tag value on a system
Check a system technical name
List tag keys
Mint a tag key
Delete a tag key
Update a tag key
Clear a platform tag value
Set a platform tag value
List the distinct values bound for a key
List tasks in scope
Get a task
List variables (admin directory)
Create a variable
Delete a variable
Update a variable's value
List vendors
Create a vendor
Get a vendor
Delete a vendor
Update a vendor
GitHub
Select theme
Dark
Light
Auto
Overview
Omniglass
0.0.1-skeleton
Section titled “Omniglass 0.0.1-skeleton”
Information
OpenAPI version:
3.1.0
Operations
Section titled “ Operations ”
GET
/audit-log
POST
/auth/login
POST
/auth/logout
GET
/auth/me
PATCH
/auth/me
GET
/auth/me/avatar
GET
/auth/me/sessions
POST
/auth/me/sessions/{id}:revoke
POST
/auth/me/sessions:revokeAll
POST
/auth/me/tokens
POST
/auth/me:changePassword
POST
/auth/me:removeAvatar
POST
/auth/me:setAvatar
POST
/auth/me:stopImpersonation
GET
/auth/status
GET
/capabilities
POST
/capabilities
GET
/capabilities/{id}
DELETE
/capabilities/{id}
PATCH
/capabilities/{id}
GET
/components
POST
/components
GET
/components/{name}
DELETE
/components/{name}
PATCH
/components/{name}
GET
/components/{name}/alarms
POST
/components/{name}/alarms
DELETE
/components/{name}/alarms/{id}
GET
/components/{name}/capabilities
PUT
/components/{name}/capabilities/{capability}
DELETE
/components/{name}/capabilities/{capability}
GET
/components/{name}/effective-secrets
GET
/components/{name}/effective-tags
GET
/components/{name}/effective-variables
GET
/components/{name}/events
GET
/components/{name}/memberships
GET
/components/{name}/properties
PUT
/components/{name}/properties/{property}
DELETE
/components/{name}/properties/{property}
GET
/components/{name}/reachability
GET
/components/{name}:listTags
POST
/components/{name}:removeTag
POST
/components/{name}:setTag
POST
/components:checkName
GET
/drivers
POST
/drivers
GET
/drivers/{id}
DELETE
/drivers/{id}
PATCH
/drivers/{id}
GET
/files
POST
/files
GET
/files/{id}
DELETE
/files/{id}
GET
/files/{id}:download
GET
/healthz
GET
/interfaces
POST
/interfaces
GET
/interfaces/{id}
DELETE
/interfaces/{id}
PATCH
/interfaces/{id}
GET
/location-types
POST
/location-types
DELETE
/location-types/{id}
PATCH
/location-types/{id}
GET
/location-types/{id}/properties
PUT
/location-types/{id}/properties/{property}
DELETE
/location-types/{id}/properties/{property}
GET
/locations
POST
/locations
GET
/locations/{name}
DELETE
/locations/{name}
PATCH
/locations/{name}
GET
/locations/{name}/health
GET
/locations/{name}/properties
PUT
/locations/{name}/properties/{property}
DELETE
/locations/{name}/properties/{property}
GET
/locations/{name}:listTags
POST
/locations/{name}:removeTag
POST
/locations/{name}:setTag
POST
/locations:checkName
GET
/nodes
POST
/nodes
GET
/nodes/{name}
DELETE
/nodes/{name}
PATCH
/nodes/{name}
POST
/nodes/{name}:enroll
GET
/nodes/{name}:listTags
POST
/nodes/{name}:removeTag
POST
/nodes/{name}:setTag
POST
/nodes:claim
GET
/principal-groups
POST
/principal-groups
GET
/principal-groups/{id}
DELETE
/principal-groups/{id}
PATCH
/principal-groups/{id}
GET
/principal-groups/{id}/grants
POST
/principal-groups/{id}/grants
DELETE
/principal-groups/{id}/grants/{grantId}
GET
/principal-groups/{id}/members
POST
/principal-groups/{id}/members
DELETE
/principal-groups/{id}/members/{principalId}
GET
/principals
POST
/principals
GET
/principals/{id}
PATCH
/principals/{id}
GET
/principals/{id}/avatar
POST
/principals/{id}/grants
DELETE
/principals/{id}/grants/{grantId}
GET
/principals/{id}/sessions
POST
/principals/{id}/sessions/{sid}:revoke
POST
/principals/{id}/sessions:revokeAll
POST
/principals/{id}:archive
POST
/principals/{id}:disable
POST
/principals/{id}:enable
POST
/principals/{id}:impersonate
POST
/principals/{id}:purge
POST
/principals/{id}:removeAvatar
POST
/principals/{id}:resetPassword
POST
/principals/{id}:restore
POST
/principals/{id}:setAvatar
GET
/products
POST
/products
GET
/products/{id}
DELETE
/products/{id}
PATCH
/products/{id}
GET
/products/{id}/properties
PUT
/products/{id}/properties/{property}
DELETE
/products/{id}/properties/{property}
GET
/property-types
POST
/property-types
GET
/property-types/{name}
DELETE
/property-types/{name}
PATCH
/property-types/{name}
GET
/roles
GET
/secret-types
GET
/secrets
POST
/secrets
DELETE
/secrets/{id}
PATCH
/secrets/{id}
POST
/secrets/{id}:copy
POST
/secrets/{id}:reveal
GET
/settings
GET
/settings/me
DELETE
/settings/{namespace}
PATCH
/settings/{namespace}
POST
/settings:restoreDefaults
GET
/standards
POST
/standards
GET
/standards/{id}
DELETE
/standards/{id}
PATCH
/standards/{id}
GET
/standards/{id}/properties
PUT
/standards/{id}/properties/{property}
DELETE
/standards/{id}/properties/{property}
GET
/standards/{id}/roles
PUT
/standards/{id}/roles/{role}
DELETE
/standards/{id}/roles/{role}
GET
/systems
POST
/systems
GET
/systems/{name}
DELETE
/systems/{name}
PATCH
/systems/{name}
GET
/systems/{name}/health
GET
/systems/{name}/members
PUT
/systems/{name}/members/{component}
DELETE
/systems/{name}/members/{component}
POST
/systems/{name}/members/{component}:setPrimary
GET
/systems/{name}/properties
PUT
/systems/{name}/properties/{property}
DELETE
/systems/{name}/properties/{property}
GET
/systems/{name}/roles
PUT
/systems/{name}/roles/{role}
DELETE
/systems/{name}/roles/{role}
PUT
/systems/{name}/roles/{role}/assignments/{component}
DELETE
/systems/{name}/roles/{role}/assignments/{component}
GET
/systems/{name}:listTags
POST
/systems/{name}:removeTag
POST
/systems/{name}:setTag
POST
/systems:checkName
GET
/tags
POST
/tags
DELETE
/tags/{name}
PATCH
/tags/{name}
POST
/tags/{name}:clearPlatform
POST
/tags/{name}:setPlatform
GET
/tags/{name}:values
GET
/tasks
GET
/tasks/{id}
GET
/variables
POST
/variables
DELETE
/variables/{id}
PATCH
/variables/{id}
GET
/vendors
POST
/vendors
GET
/vendors/{id}
DELETE
/vendors/{id}
PATCH
/vendors/{id}