NVIDIA Run:ai

Access Keys

Access Keys allow users to authenticate and interact programmatically with the NVIDIA Run:ai API. Each access key consists of a client ID and secret that can be used to obtain authentication tokens. Access keys can be managed by individual users for their own use, or by administrators for organization-wide access. For more information, see Access control.

Get a list of access keys.

Retrieve a list of the user's access keys.

SecuritybearerAuth
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/access-keys
Response samples
application/json
{
  • "accessKeys": [
    ]
}

Create an access key.

Used to create an access key.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Access key object to create

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

The name of the access key. The name must be unique within the user's access keys list 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

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/access-keys
Request samples
application/json
{
  • "name": "access-key-name"
}
Response samples
application/json
{
  • "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  • "clientId": "5e7b3b7b4b7b4b7b",
  • "name": "access-key-123",
  • "clientSecret": "this-is-the-access-key-secret",
  • "createdAt": "2020-01-01T00:00:00Z"
}

Get access key by id.

Retrieve the details of an access key by id.

SecuritybearerAuth
Request
path Parameters
accessKeyId
required
string

The access key ID

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/access-keys/{accessKeyId}
Response samples
application/json
{
  • "name": "my-access-key",
  • "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  • "clientId": "3434c-12323ab-4ce2ea6",
  • "createdAt": "2019-01-01T00:00:00Z",
  • "lastLogin": "2020-01-01T00:00:00Z"
}

Delete an access key by id.

Use to delete an access key by id.

SecuritybearerAuth
Request
path Parameters
accessKeyId
required
string

The access key ID

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/access-keys/{accessKeyId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Regenerate an access key secret.

Use to regenerate the access key secret by id.

SecuritybearerAuth
Request
path Parameters
accessKeyId
required
string

The access key ID

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/access-keys/{accessKeyId}/secret
Response samples
application/json
{
  • "clientSecret": "this-is-my-secret"
}

Get a list of all access keys.

Retrieve a list of all access keys.

SecuritybearerAuth
Request
query Parameters
clientId
string

Filter results by clientId

Example: clientId=3434c-12323ab-4ce2ea6-b44fc-db344d
createdBy
string

Filter results by creatdBy

Example: createdBy=test@run.ai
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/administration/access-keys
Response samples
application/json
{
  • "accessKeys": [
    ]
}

Delete an access key by id for administrations.

Use to delete an access key by id for administrations.

SecuritybearerAuth
Request
path Parameters
accessKeyId
required
string

The access key ID

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/administration/access-keys/{accessKeyId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}
➔ Next to Access rules