Cloud API overview¶

The Nextmv Cloud API provides a set of HTTP endpoints to interact with Nextmv Cloud directly. The API is designed to be used by developers to integrate Nextmv Cloud into their own applications and workflows.

The following tools use the Nextmv Cloud API under the hood:

CLI: A command-line interface to interact with the Nextmv Platform.
Python SDK: A Python library to interact with the Nextmv Platform.

Get started¶

Sign up for a Nextmv account.
Get your API key. Go to Settings > API Key.

Make sure that you have your API key set as an environment variable:

export NEXTMV_API_KEY="<YOUR-API-KEY>"

All requests must be authenticated with Bearer Authentication. Make sure your request has a header containing your Nextmv Cloud API key:

Key: Authorization
Value: Bearer <YOUR-API-KEY>

Authorization: Bearer <YOUR-API-KEY>

Pagination¶

Some of our GET endpoints return paginated results. If additional records exist, a next_page_token will be returned in the response. This token can be used to retrieve additional records by setting its value to the query parameter pagetoken.

If the next_page_token key is not returned on a endpoint that supports pagination, there are no additional records.

Below is a simplified structure that mirrors the list runs endpoint.

{
  "runs": [...],
  "next_page_token": "sampletoken"
}

The next set of records can be obtained by adding pagetoken=sampletoken as a query parameter on the URL used in the original request.