Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

get

Retrieve a list of the user's access keys.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
get/api/v1/access-keys
GET /api/v1/access-keys HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "accessKeys": [
    {
      "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"
    },
    {
      "name": "another-access-key",
      "id": "5656d-45645cd-6de3fb7-c55gd-ef455e",
      "clientId": "5656d-45645cd-6de3fb7",
      "createdAt": "2019-01-01T00:00:00Z",
      "lastLogin": "2020-01-01T00:00:00Z"
    }
  ]
}

Create an access key.

post

Used to create an access key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestring · min: 2 · max: 255Required

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.

Pattern: ^[a-z][-_a-z0-9]*[a-z0-9]$
Responses
201

Executed successfully.

application/json
idstringRequired

The unique identifier of the access key.

clientIdstringRequired

The client identifier associated with the access key. Used when requesting authentication tokens.

namestringRequired

The name of the access key.

clientSecretstringRequired

Secret credential paired with the client ID. Used to obtain authentication tokens. Displayed only once upon creation.

createdAtstring · date-time · nullableRequired

The timestamp for when the access key was created.

post/api/v1/access-keys
POST /api/v1/access-keys HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "name": "access-key-name"
}
{
  "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.

get

Retrieve the details of an access key by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
accessKeyIdstringRequired

The access key ID

Responses
200

Executed successfully.

application/json
namestringRequired

The name of the access key.

clientIdstringRequired

The client identifier associated with the access key. Used when requesting authentication tokens.

idstringRequired

The unique identifier of the access key.

createdAtstring · date-time · nullableRequired

The timestamp for when the access key was created.

lastLoginstring · date-time · nullableRequired

The timestamp of the last time the access key was used to authenticate.

get/api/v1/access-keys/{accessKeyId}
GET /api/v1/access-keys/{accessKeyId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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.

delete

Use to delete an access key by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
accessKeyIdstringRequired

The access key ID

Responses
204

Executed successfully.

No content
delete/api/v1/access-keys/{accessKeyId}
DELETE /api/v1/access-keys/{accessKeyId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Regenerate an access key secret.

post

Use to regenerate the access key secret by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
accessKeyIdstringRequired

The access key ID

Responses
200

Regenerated successfully.

application/json
clientSecretstringOptional

Secret credential paired with the client ID. Used to obtain authentication tokens.

post/api/v1/access-keys/{accessKeyId}/secret
POST /api/v1/access-keys/{accessKeyId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clientSecret": "this-is-my-secret"
}

Get a list of all access keys.

get

Retrieve a list of all access keys.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
clientIdstringOptional

Filter results by clientId

Example: 3434c-12323ab-4ce2ea6-b44fc-db344d
createdBystringOptional

Filter results by creatdBy

Example: test@run.ai
Responses
200

Executed successfully.

application/json
get/api/v1/administration/access-keys
GET /api/v1/administration/access-keys HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "accessKeys": [
    {
      "name": "my-access-key",
      "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
      "clientId": "1434c-123233ab-4ce2ea6-b44fc-db344d",
      "createdBy": "test@run.ai",
      "createdAt": "2020-01-01T00:00:00Z",
      "lastLogin": "2020-01-01T00:00:00Z"
    },
    {
      "name": "another-access-key",
      "id": "5656d-45645cd-6de3fb7-c55gd-ef455e",
      "clientId": "2545e-234344bc-5df4gc8-d66he-fg566f",
      "createdBy": "user@run.ai",
      "createdAt": "2020-01-01T00:00:00Z",
      "lastLogin": "2020-01-01T00:00:00Z"
    }
  ]
}

Delete an access key by id for administrations.

delete

Use to delete an access key by id for administrations.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
accessKeyIdstringRequired

The access key ID

Responses
204

Executed successfully.

No content
delete/api/v1/administration/access-keys/{accessKeyId}
DELETE /api/v1/administration/access-keys/{accessKeyId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousClustersNextAccess rules

Last updated