Reference

App REST API

Technical reference for the Nextmv Cloud REST API for applications.

The applications REST API endpoints can be used to manage, run and deploy applications to Nextmv Cloud. For the Nextmv CLI app command set see the nextmv app CLI reference.

Endpoints

The endpoints can be used to:

  • Create, view, edit and delete applications.
  • Create, view, edit and delete versions.
  • Create, view, edit and delete instances.
  • Create new runs and retrieve the results.

Read more about versions and instances in the Nextmv Cloud overview.

Applications

POSThttps://api.cloud.nextmv.io/v1/applications

Creates an application.

Create a new application. Applications are used to manage versions, instances, testing, and other configuration information for a decision optimization solution you are developing and using for your business. Applications can be queried through the `/applications endpoint` `GET` operation

GEThttps://api.cloud.nextmv.io/v1/applications

List all applications for an account.

List all applications.

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

Get an application definition

Get the application definition specified by application id

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

Updates an application definition.

Updates an existing application. This replaces the existing definition information

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

Deletes an application definition.

Deletes an existing application.

Versions

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

Creates an application version.

Create a new application version. Uses the current dev binary to create the application version.

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

List all versions of an application.

List all versions of an application.

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

Get an application definition"

Get the application definition specified by application id

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

Updates an application version.

Updates an existing application version. This replaces the existing definition information

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

Deletes an application version.

Deletes an existing application version.

Instances

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

Creates an application instance.

Create a new application instance for a version and configuration specified.

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

List all instances of an application.

List all instances of an application.

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

Get an application instance

Get the application instance for the application and instance id specified

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

Updates an application version.

Puts an existing application instance. This replaces the existing definition information

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

Deletes an application instance.

Deletes an existing application instance.

Runs

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

Creates an application run.

Create a new application run.

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

Gets the results of a run for an application

Get the results of a run

Page last updated

Go to on-page nav menu