To add or edit subnets, go to the Admin page. Click Add Subnet to create a new subnet, or use the edit button to modify existing subnets. Subnets are associated with sites and can be organised by location.
To add a device, visit the Devices page and click Add Device.
To assign an IP address, you must first add a device. Then, from the Devices page, click on a device to view its details and use the Add IP option to assign an IP address from a subnet.
Click on any device in the Devices list to view or edit its details, including assigned IPs, device types and a description where necessary.
To add a new rack, go to the Racks page and click the Add Rack button. Fill in the details and submit the form.
After adding a device, you can assign it to a rack from the Rack details page. Click on a rack from the Racks page, then use the options to add or remove devices within the rack.
Racks can also contain non-networked devices (such as shelves, patch panels, or other equipment that does not require an IP address). To add a non-networked device, go to a rack details page and use the option to add a device by name without assigning an IP address. These devices will appear in the rack layout but will not be listed on the Devices page.
Administrators can manage users and roles from the Users page. This includes creating users, assigning roles, and managing custom roles with specific permission sets. Only users with the appropriate permissions can access this page.
The system uses role-based access control to manage what users can do. There are three default roles:
Administrators can create custom roles with specific permission sets. Go to the Users page and click the "Roles & Permissions" tab to create and manage roles.
Permissions are very granular, allowing fine-grained control over what each role can do. Permissions are organised into categories like View, Device Management, Network Management, Rack Management, and Administration.
All changes are logged and can be reviewed on the Audit page for accountability and troubleshooting. The audit log shows who made changes, what was changed, and when.
Each user has a unique API key that can be used to authenticate API requests. API keys can be viewed and regenerated from the Users page. Keep your API key secure and never share it publicly.
All API requests require authentication using an API key. You can provide the API key in one of three ways:
X-API-Key: your_api_keyAuthorization: Bearer your_api_key?api_key=your_api_keyAll API endpoints are prefixed with /api/v1
GET /api/v1/devices - List all devicesGET /api/v1/devices/{id} - Get device detailsPOST /api/v1/devices - Create devicePUT /api/v1/devices/{id} - Update deviceDELETE /api/v1/devices/{id} - Delete devicePOST /api/v1/devices/{id}/ips - Add IP to deviceDELETE /api/v1/devices/{id}/ips/{ip_id} - Remove IP from deviceGET /api/v1/subnets - List all subnetsGET /api/v1/subnets/{id} - Get subnet detailsPOST /api/v1/subnets - Create subnetPUT /api/v1/subnets/{id} - Update subnetDELETE /api/v1/subnets/{id} - Delete subnetGET /api/v1/racks - List all racksGET /api/v1/racks/{id} - Get rack detailsPOST /api/v1/racks - Create rackDELETE /api/v1/racks/{id} - Delete rackPOST /api/v1/racks/{id}/devices - Add device to rackDELETE /api/v1/racks/{id}/devices/{rack_device_id} - Remove device from rackGET /api/v1/info - Get API info and user detailsGET /api/v1/device-types - List device typesGET /api/v1/subnets/{id}/dhcp - Get DHCP poolsPOST /api/v1/subnets/{id}/dhcp - Configure DHCP poolsGET /api/v1/audit - Get audit logGET /api/v1/users - List users (admin only)GET /api/v1/roles - List roles (admin only)API endpoints respect the same role-based permissions as the web interface. Users can only perform actions that their role allows. If a user lacks the required permission, the API will return a 403 Forbidden error.
All API responses are in JSON format. Successful requests return 200 OK or 201 Created with the requested data. Errors return appropriate HTTP status codes with an error message in the response body.