Reference

Nextmv routing app on marketplace API

Technical reference for the Nextmv routing app on marketplace API.

When you subscribe to the Nextmv routing app on marketplace, you get a personalized app with a variety of API endpoints that can be used to execute and manage runs.

In this page you can find the API reference for a subscribed app, which you can also explore in Nextmv Console.

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>
Authorization: Bearer <YOUR-API-KEY>
Copy

Run execution

POSThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs

New application run.

Create new application run.

GEThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs/{run_id}

Get run result.

Get the result of a run.

Run management

GEThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs

List past runs.

List past runs for application (50 max per request).

PUThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs/{run_id}

Update name and description of run.

Update the name and/or description of a run.

GEThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs/{run_id}/metadata

Get run status without output.

Get the status of a run without the output.

GEThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs/{run_id}/input

Get run input.

Gets the input used for a run.

POSThttps://api.cloud.nextmv.io/v1/applications/{application_id}/runs/uploadurl

Retrieve unique upload URL and ID.

Retrieve a unique URL and ID for uploading run input (for large input files).

Admin

GEThttps://api.cloud.nextmv.io/v1/applications/{application_id}

Get application information.

Get application information specified by application ID.

PUThttps://api.cloud.nextmv.io/v1/applications/{application_id}

Update application information.

Update application information with defined data, specified by application ID.

DELETEhttps://api.cloud.nextmv.io/v1/applications/{application_id}

Delete application.

Delete application, specified by application ID.

Page last updated

Go to on-page nav menu