Skip to content
Æ
AETHERS
Docs
· v0.1.0
Tutorials
Aethers
API
Home
GitHub
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Sign in
Getting started
Introduction
Self-hosted (coming soon)
Aethers
All Aethers
Infrastructure
Beta
Overview
Regions
Sites
Locations
Racks
Manufacturers
Platforms
Device Roles
Device Types
Devices
Interfaces
Cables
Power Panels
Power Feeds
Network
Beta
Virtual
Beta
Circuits
Beta
Inventory
Beta
Tenancy
Beta
Vendor
Beta
Operations
Beta
Insight
Planned
API reference
Overview
system
Overview
Health check
GET
Instance info
GET
System info
GET
auth
Overview
Create account
POST
Sign in
POST
Sign out
POST
Get current user
GET
profiles
Overview
List all users (admin)
GET
Get own profile
GET
Update own profile
PATCH
Get user by ID (admin)
GET
Delete user (admin)
DELETE
Update user (admin)
PATCH
regions
Overview
List regions
GET
Create region
POST
Get region
GET
Delete region
DELETE
Update region
PATCH
sites
Overview
List sites
GET
Create site
POST
Get site
GET
Delete site
DELETE
Update site
PATCH
locations
Overview
List locations
GET
Create location
POST
Get location
GET
Delete location
DELETE
Update location
PATCH
racks
Overview
List racks
GET
Create rack
POST
Get rack
GET
Delete rack
DELETE
Update rack
PATCH
devices
Overview
List devices
GET
Create device
POST
Get device
GET
Delete device
DELETE
Update device
PATCH
Bulk-create devices
POST
List device ports
GET
Add device port
POST
Bulk-create device ports
POST
Delete device port
DELETE
Update device port
PATCH
List device IP addresses
GET
device-types
Overview
List device types
GET
Create device type
POST
Get device type
GET
Delete device type
DELETE
Update device type
PATCH
Clone device type
POST
List device type modules
GET
Add device type module
POST
Delete device type module
DELETE
Update device type module
PATCH
device-roles
Overview
List device roles
GET
Create device role
POST
Get device role
GET
Delete device role
DELETE
Update device role
PATCH
Clone device role
POST
platforms
Overview
List platforms
GET
Create platform
POST
Get platform
GET
Delete platform
DELETE
Update platform
PATCH
Clone platform
POST
interfaces
Overview
List interfaces
GET
Create interface
POST
Get interface
GET
Delete interface
DELETE
Update interface
PATCH
cables
Overview
List cables
GET
Create cable
POST
Get cable
GET
Delete cable
DELETE
Update cable
PATCH
power-panels
Overview
List power panels
GET
Create power panel
POST
Get power panel
GET
Delete power panel
DELETE
Update power panel
PATCH
power-feeds
Overview
List power feeds
GET
Create power feed
POST
Get power feed
GET
Delete power feed
DELETE
Update power feed
PATCH
diagrams
Overview
List diagrams
GET
Create diagram
POST
Get diagram
GET
Delete diagram
DELETE
Update diagram
PATCH
vrfs
Overview
List VRFs
GET
Create VRF
POST
Get VRF
GET
Delete VRF
DELETE
Update VRF
PATCH
vlan-groups
Overview
List VLAN groups
GET
Create VLAN group
POST
Get VLAN group
GET
Delete VLAN group
DELETE
Update VLAN group
PATCH
vlans
Overview
List VLANs
GET
Create VLAN
POST
Get VLAN
GET
Delete VLAN
DELETE
Update VLAN
PATCH
prefixes
Overview
List prefixes
GET
Create prefix
POST
Get prefix
GET
Delete prefix
DELETE
Update prefix
PATCH
ip-addresses
Overview
List IP addresses
GET
Create IP address
POST
Get IP address
GET
Delete IP address
DELETE
Update IP address
PATCH
Bulk-create IP addresses
POST
assets
Overview
List assets
GET
Create asset
POST
Get asset
GET
Delete asset (admin)
DELETE
Update asset
PATCH
Assign asset
POST
Return asset
POST
List asset assignment history
GET
asset-categories
Overview
List asset categories
GET
Create asset category (admin)
POST
Get asset category
GET
Delete asset category (admin)
DELETE
Update asset category (admin)
PATCH
manufacturers
Overview
List manufacturers
GET
Create manufacturer
POST
Get manufacturer
GET
Delete manufacturer
DELETE
Update manufacturer
PATCH
Clone manufacturer
POST
purchase-orders
Overview
List purchase orders
GET
Create purchase order
POST
Get purchase order
GET
Delete purchase order
DELETE
Update purchase order
PATCH
Add line item
POST
Delete line item
DELETE
Update line item
PATCH
Receive purchase order items
POST
people
Overview
List people
GET
Create person
POST
Get person
GET
Delete person
DELETE
Update person
PATCH
List person current assets
GET
List person asset history
GET
asns
Overview
List ASNs
GET
Create ASN
POST
Get ASN
GET
Delete ASN
DELETE
Update ASN
PATCH
route-targets
Overview
List route targets
GET
Create route target
POST
Get route target
GET
Delete route target
DELETE
Update route target
PATCH
cluster-types
Overview
List cluster types
GET
Create cluster type
POST
Get cluster type
GET
Delete cluster type
DELETE
Update cluster type
PATCH
cluster-groups
Overview
List cluster groups
GET
Create cluster group
POST
Get cluster group
GET
Delete cluster group
DELETE
Update cluster group
PATCH
clusters
Overview
List clusters
GET
Create cluster
POST
Get cluster
GET
Delete cluster
DELETE
Update cluster
PATCH
virtual-machines
Overview
List virtual machines
GET
Create virtual machine
POST
Get virtual machine
GET
Delete virtual machine
DELETE
Update virtual machine
PATCH
vm-interfaces
Overview
List VM interfaces
GET
Create VM interface
POST
Get VM interface
GET
Delete VM interface
DELETE
Update VM interface
PATCH
providers
Overview
List providers
GET
Create provider
POST
Get provider
GET
Delete provider
DELETE
Update provider
PATCH
provider-networks
Overview
List provider networks
GET
Create provider network
POST
Get provider network
GET
Delete provider network
DELETE
Update provider network
PATCH
circuit-types
Overview
List circuit types
GET
Create circuit type
POST
Get circuit type
GET
Delete circuit type
DELETE
Update circuit type
PATCH
circuits
Overview
List circuits
GET
Create circuit
POST
Get circuit
GET
Delete circuit
DELETE
Update circuit
PATCH
software-licences
Overview
List software licences
GET
Create software licence
POST
Get software licence
GET
Delete software licence
DELETE
Update software licence
PATCH
warranties
Overview
List warranties
GET
Create warranty
POST
Get warranty
GET
Delete warranty
DELETE
Update warranty
PATCH
tenant-groups
Overview
List tenant groups
GET
Create tenant group
POST
Get tenant group
GET
Delete tenant group
DELETE
Update tenant group
PATCH
tenants
Overview
List tenants
GET
Create tenant
POST
Get tenant
GET
Delete tenant
DELETE
Update tenant
PATCH
contact-roles
Overview
List contact roles
GET
Create contact role
POST
Get contact role
GET
Delete contact role
DELETE
Update contact role
PATCH
contact-groups
Overview
List contact groups
GET
Create contact group
POST
Get contact group
GET
Delete contact group
DELETE
Update contact group
PATCH
contacts
Overview
List contacts
GET
Create contact
POST
Get contact
GET
Delete contact
DELETE
Update contact
PATCH
vendors
Overview
List vendors
GET
Create vendor
POST
Get vendor
GET
Delete vendor
DELETE
Update vendor
PATCH
contracts
Overview
List contracts
GET
Create contract
POST
Get contract
GET
Delete contract
DELETE
Update contract
PATCH
slas
Overview
List SLAs
GET
Create SLA
POST
Get SLA
GET
Delete SLA
DELETE
Update SLA
PATCH
renewals
Overview
List renewals
GET
Create renewal
POST
Get renewal
GET
Delete renewal
DELETE
Update renewal
PATCH
on-call-schedules
Overview
List on-call schedules
GET
Create on-call schedule
POST
Get on-call schedule
GET
Delete on-call schedule
DELETE
Update on-call schedule
PATCH
runbooks
Overview
List runbooks
GET
Create runbook
POST
Get runbook
GET
Delete runbook
DELETE
Update runbook
PATCH
known-issues
Overview
List known issues
GET
Create known issue
POST
Get known issue
GET
Delete known issue
DELETE
Update known issue
PATCH
maintenance-windows
Overview
List maintenance windows
GET
Create maintenance window
POST
Get maintenance window
GET
Delete maintenance window
DELETE
Update maintenance window
PATCH
change-requests
Overview
List change requests
GET
Create change request
POST
Get change request
GET
Delete change request
DELETE
Update change request
PATCH
incidents
Overview
List incidents
GET
Create incident
POST
Get incident
GET
Delete incident
DELETE
Update incident
PATCH
activity
Overview
List activity log (admin)
GET
usage
Overview
Get resource usage counts (admin)
GET
updates
Overview
Check for updates (admin)
GET
Get update configuration (admin)
GET
admin-seed
Overview
Bulk-upsert manufacturers (admin)
POST
Bulk-upsert platforms (admin)
POST
Bulk-upsert device roles (admin)
POST
Bulk-upsert device types (admin)
POST
Bulk-upsert device-type modules (admin)
POST
account
Register company in tenant_registry (portal, owner-only)
POST
GitHub
Select theme
Dark
Light
Auto
Overview
usage
Section titled “usage”
Resource usage counts (admin)
Operations
Section titled “ Operations ”
GET
/api/admin/usage