Skip to content

Nautobot Cloud REST API

External services interacting with the Nautobot Cloud API

You can manage your cloud deployments programmatically via a REST api. To find out more and explore the API documentation, visit the Nautobot Cloud REST API Docs. You must be logged in to view the Cloud API documentation.

GO TO CLOUD API DOCS

You can also find the API docs quickly from the Nautobot Cloud Console by finding the "API Docs" link in the footer.

Screenshot of the Nautobot Cloud Console with the API Docs link at the bottom of the page.

Automating Deployments

The API lets you script anything you would otherwise do in the Console — upload and install a custom App build, set instance settings and Secrets, trigger an Update, promote an image between environments, or take a Snapshot. See Automate with the API for step-by-step guides and a complete GitHub Actions example.

Explore the API

  • Browse every endpoint, with request and response schemas, in the interactive API reference.
  • Download the OpenAPI schema from https://nautobot.cloud/api/swagger.yaml (or swagger.json) to generate a client library or import the API into your tooling. Send your API token with the request.
  • Conventions such as pagination, expanding nested objects, and identifying your automation in Event History are described in Working with the API.

Authenticating to the API

Requests to the Nautobot Cloud API are authenticated with an API token tied to your user account.

Get your API token

  1. Open your user menu in the top-right corner and go to Profile Tokens.
  2. If you don't have an API token yet, the page says so — click Generate and confirm to create one.

    The Tokens page before a token exists, with the Generate button and the User, Organization, and Private Cloud IDs

  3. Copy your token with the copy icon. The same page also shows your User ID, Organization ID, and Private Cloud ID (each copyable), which some API calls require.

    The Tokens page showing the API token with its copy and re-generate icons

Send the token in the Authorization header using the Token scheme (see the API docs for the available endpoints):

curl -H "Authorization: Token <your-token>" "https://nautobot.cloud/<endpoint>"

Rotate your token

To rotate your token — for example, if it may have been exposed — use the regenerate icon next to your token on the Tokens page. Regenerating immediately invalidates the previous token, so update any scripts or integrations with the new value.

Note

The Nautobot Cloud REST API is different from the Nautobot Core API. While the Cloud API lets you create and manage instances themselves, the Core API is for the Nautobot instance and the data within it.