NVIDIA Run:ai

Applications

Create and manage applications in the tenant.

Get a list of applications.

Retrieve a list of applications.

SecuritybearerAuth
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/apps
Response samples
application/json
[
  • {
    }
]

Create an application.

Used to create an application.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Application object to create

name
required
string^[a-z][-_a-z0-9]*[a-z0-9]$

The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Responses
201

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/apps
Request samples
application/json
{
  • "name": "app-123"
}
Response samples
application/json
{
  • "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  • "name": "app123",
  • "secret": "asdasidjn9d",
  • "clientId": "app123"
}

Get application by id.

Retrieve the details of an application by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/apps/{appId}
Response samples
application/json
{
  • "name": "app123",
  • "createdBy": "test@run.ai",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "enabled": true,
  • "tenantId": 1234567890,
  • "lastLogin": "2020-01-01T00:00:00Z",
  • "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  • "clientId": "app123"
}

Update application details by id.

Use to update the details of an application by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

Request Body schema: application/json

Application object that needs to be updated.

enabled
required
boolean
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/apps/{appId}
Request samples
application/json
{
  • "enabled": true
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Delete an application by id.

Use to delete an application by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

Responses
204

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/apps/{appId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Regenerate an application secret.

Use to regenerate the application secret by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

Responses
200

Regenerated successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/apps/{appId}/secret
Response samples
application/json
{
  • "secret": "189ej2ijd92fj092k049fk0"
}
➔ Next to Roles