Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Access Keys API

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](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/overview/#role-based-access-control).

NVIDIA Run:ai Access Keys API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Access Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

7 operations 5 paths 7 schemas 2 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Access Keys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Access Keys 7

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 aut…

GET
/api/v1/access-keys
Get a list of access keys.
get_access_keys → 200401403500503
POST
/api/v1/access-keys
Create an access key.
create_access_key1 body → 201400401403409500503
GET
/api/v1/access-keys/{accessKeyId}
Get access key by id.
get_access_key_by_id1 1 param → 200401403404500503
DELETE
/api/v1/access-keys/{accessKeyId}
Delete an access key by id.
delete_access_key_by_id 1 param → 204400401403404500503
POST
/api/v1/access-keys/{accessKeyId}/secret
Regenerate an access key secret.
regenerate_access_key_secret 1 param → 200400401403404500503
GET
/api/v1/administration/access-keys
Get a list of all access keys.
get_access_keys_administration 2 params → 200401403404500503
DELETE
/api/v1/administration/access-keys/{accessKeyId}
Delete an access key by id for administrations.
delete_access_key_by_id_administration 1 param → 204400401403404500503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are AccessKeyAdministration (6 properties), AccessKey1 (5 properties), AccessKeyPostResponse (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

AccessKeyAdministration
object
6 properties 6 required
AccessKeys
object
1 property 1 required
AccessKeyCreationRequest1
object
1 property 1 required
AccessKeyPostResponse
object
5 properties 5 required
AccessKeysAdministration
object
1 property 1 required
Error
object
3 properties 2 required
AccessKey1
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-access-keys-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API
NVIDIA Run:ai Departments API