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 rules API

Access rules provide user authorization to system resources and entities.It is managed using Role-based access control (RBAC) which is a policy-neutral access control mechanism defined around roles and privileges. The components of RBAC make it simple to manage access to system resources and entities.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 rules 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 rules. 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 29 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 29 schemas 1 DELETE3 GET3 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 rules 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 — 1 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Access rules 7

Access rules provide user authorization to system resources and entities. It is managed using Role-based access control (RBAC) which is a policy-neutral access control mechanism d…

POST
/api/v1/authorization/access-rules
Create an access rule.
create_access_rule body → 201400401403404500503
GET
/api/v1/authorization/access-rules
List the access rules.
get_access_rules 15 params → 200401403500503
GET
/api/v1/authorization/access-rules/{accessRuleId}
Get an access rule.
get_access_rule 1 param → 200401403404500503
DELETE
/api/v1/authorization/access-rules/{accessRuleId}
Delete an access rule.
delete_access_rule 1 param → 204401403404500503
GET
/api/v1/authorization/access-rules/count
Count access rules.
count_access_rules 3 params → 200400401403500503
POST
/api/v1/authorization/access-rules/batch
Delete Multiple Access Rules
access_rules_batch body → 200400401403500503
POST
/api/v1/authorization/access-rules/batch-create
Create Multiple Access Rules
access_rules_batch_create body → 200400401403500503

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are AccessRuleMetadataFields (6 properties), AccessRuleCreationFields (6 properties), AccessRuleStatusResponse (3 properties), AccessRuleDeletionBatchResponseFailureItem (3 properties). Each schema is shown below with its type and property counts.

AccessRuleDeletionBatchIdsList
array
List of access rule IDs that were successfully deleted.
AccessRuleById
AccessRulesSortFilterFields
string
EnrichmentDataFields
object
2 properties 2 required
AccessRuleCreationFields
object
6 properties 5 required
AccessRuleStatusResponse
object
Status of the Access Rule in the cluster. Available only for clusters of version 2.22.0 or above.
3 properties
AccessRuleMetadataFields
object
6 properties 4 required
ErrorCode
integer
A numeric code representing the error type.
AccessRuleDeletionBatchResponse
object
3 properties 1 required
Error
object
3 properties 2 required
AccessRuleDeletionBatchResponseFailureItem
object
3 properties 3 required
AccessRuleDeletionBatchId
string
The unique ID of the batch operation.
ScopeType
string
AccessRulesBatchFields
object
Deletes a batch of access rules in a single operation. It requires a list of rule IDs and an action flag explicitly set to "delete". It returns the result of t…
2 properties 2 required
TenantId
integer
The id of the tenant.
ClusterId
string
The id of the cluster.
AccessRules
array
AccessRulesBatchCreateResponse
object
2 properties
AccessRuleSubjects
array
subjects for the access rules. must have at least one value
AccessRule
AccessRulesBatchCreateFields
object
1 property 1 required
ScopeId
string
The id of the cluster, department or project, depending on the scope type.
IdsList
array
List of ids to perform the action on.
AccessRulesBatchAction
string
Specifies the operation to perform. Must be set to "delete".
AccessRuleDeletionBatchErrorMessage
string
A human-readable message describing the access rule IDs that failed to delete.
SubjectType
string
Subject type enum for access rules. Note: The 'app' subject type is DEPRECATED. Please use 'service-account' instead for service accounts.
AccessRuleDeletionBatchErrorCode
integer
A numeric code representing the error type.
AccessRuleScopes
array
scopes for the access rules. must have at least one value
AccessRulePhase
string
Phase of the Access Rule in the cluster.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys 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