Cloud

Cloud API

The NetBox Cloud API provides programmatic access to platform operations using API keys. You can use it to automate tasks like triggering backups or monitoring restore jobs from your own tooling or pipelines.

This is not the same as the NetBox REST API, which is used to query and manage data inside a NetBox instance. The Cloud API allows you to manage your NetBox Cloud administrative function -- things like backups and restores -- from outside the instance.

The base URL for all requests is:

https://api.netboxlabs.com/v2/

Available resources

The Cloud API currently exposes:

Backups -- request backups, download backup files, and restore from a backup

Next steps

Create an API key in the Console
Authenticate your requests using the key
Review permissions to understand what each key can access
Use the Backups API to manage backups programmatically

Available resources​

Next steps​

Available resources

Next steps