Note, all requests must be authenticated with Bearer Authentication. Make sure your request has a header containing your Nextmv Cloud API key, as such:
- Key:
Authorization
- Value:
Bearer <YOUR-API-KEY>
Export your API key as an environment variable:
New run
Submit a new run. The run_id
is returned.
New application run.
Create new application run.
Run metadata
Get a run metadata. The metadata.status
key will contain the status of the run. Use the run_id
obtained from submitting a run.
Get run status without output.
Get the status of a run without the output.
Run result
Get a run result. The output
key will contain the actual output of the run. Use the run_id
obtained from submitting a run.
Get run result.
Get the result of a run.
Cancel a run
To cancel a run, use the following endpoint.
Cancel a run that is not yet completed.
Cancel a run that is not yet completed.
Account queue
Get the queue of runs for the account using this endpoint. A run is queued when the status_v2
in the metadata is queued
.
List queued and active runs.
Retrieves a list of queued and active runs.