{ "opencollection": "1.0.0", "info": { "name": "NVIDIA Run:ai Access Keys Credentials API", "version": "latest" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "List credentials.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve a list of all existing credentials." }, { "info": { "name": "List access keys.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/access-key", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve a list of S3-compatible access key credentials." }, { "info": { "name": "Create an access key.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/credentials/access-key", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create an S3-compatible access key credential." }, { "info": { "name": "Get an access key.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/access-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve the details of an S3-compatible access key credential by id." }, { "info": { "name": "Update an access key.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/credentials/access-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use to update the details of an S3-compatible access key credential by id." }, { "info": { "name": "Delete an access key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/credentials/access-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Use to delete an S3-compatible access key credential by id." }, { "info": { "name": "List password credentials.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/password", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve a list of password credentials." }, { "info": { "name": "Create a userid / password credential.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/credentials/password", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create a userid / password credential." }, { "info": { "name": "Get a userid / password credential.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/password/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve the details of a userid / password credential asset by id." }, { "info": { "name": "Update a password credential.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/credentials/password/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use to Update the details of a password credential by id." }, { "info": { "name": "Delete a password asset.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/credentials/password/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Udse to delete a password credential by id." }, { "info": { "name": "List docker registry credentials.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/docker-registry", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve a list of docker registry credentials." }, { "info": { "name": "Create a docker registry credential.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/credentials/docker-registry", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create a docker registry credential containing userid, password and url." }, { "info": { "name": "Get a docker registry credential.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/docker-registry/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Use to retrieve the details of a docker registry credential by id." }, { "info": { "name": "Update a docker registry credential.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/credentials/docker-registry/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use to updates the details of a docker registry credentials by id." }, { "info": { "name": "Delete a docker registry credential.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/credentials/docker-registry/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Use to deletes a docker registry credential by id." }, { "info": { "name": "List generic-secrets.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/generic-secret", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Retrieve a list of generic-secret assets." }, { "info": { "name": "Create a generic-secret.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/credentials/generic-secret", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create a generic-secret asset." }, { "info": { "name": "Get a generic-secret.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/generic-secret/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Returns the details of a generic-secret asset, by id." }, { "info": { "name": "Update a generic-secret.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/credentials/generic-secret/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a generic-secret asset, by id." }, { "info": { "name": "Delete a generic-secret.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/credentials/generic-secret/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Use to delete a generic-secret asset, by id." }, { "info": { "name": "List ngc-api-keys.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/ngc-api-key", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter results by name." }, { "name": "scope", "value": "", "type": "query", "description": "Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project." }, { "name": "projectId", "value": "", "type": "query", "description": "Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets." }, { "name": "departmentId", "value": "", "type": "query", "description": "Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets." }, { "name": "clusterId", "value": "", "type": "query", "description": "Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Retrieve a list of ngcApiKey assets." }, { "info": { "name": "Create a ngc-api-key.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/credentials/ngc-api-key", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create a ngc-api-key asset." }, { "info": { "name": "Get a ngc-api-key.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/credentials/ngc-api-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." }, { "name": "usageInfo", "value": "", "type": "query", "description": "Whether the query should include asset usage information as part of the response." }, { "name": "statusInfo", "value": "", "type": "query", "description": "Whether the query should include asset status information as part of the response." } ] }, "docs": "Returns the details of a ngc-api-key asset, by id." }, { "info": { "name": "Update a ngc-api-key.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/credentials/ngc-api-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a ngc-api-key asset, by id." }, { "info": { "name": "Delete a ngc-api-key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/credentials/ngc-api-key/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Use to delete a ngc-api-key asset, by id." } ] } ], "bundled": true }