{ "opencollection": "1.0.0", "info": { "name": "NVIDIA Run:ai Access Keys Compute API", "version": "latest" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Compute", "type": "folder" }, "items": [ { "info": { "name": "List compute assets.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/compute", "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": "complyToProject", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type." }, { "name": "complyToWorkloadType", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type." }, { "name": "complyToReplicaType", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well." }, { "name": "includeDescendants", "value": "", "type": "query", "description": "Indicates whether to include assets from all descendant scopes under the specified scope. When set to true, and a specific scope identifier (for example, clusterId) is provided, the query also returns assets from all nested scopes within it (for example, departments and projects). Mutually exclusive with scope." } ] }, "docs": "Use to retrieve a list of compute assets." }, { "info": { "name": "Create compute asset.", "type": "http" }, "http": { "method": "POST", "url": "https://app.run.ai/api/v1/asset/compute", "body": { "type": "json", "data": "{}" } }, "docs": "Use to create a compute asset." }, { "info": { "name": "Retrieve a compute asset.", "type": "http" }, "http": { "method": "GET", "url": "https://app.run.ai/api/v1/asset/compute/: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": "complyToProject", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type." }, { "name": "complyToWorkloadType", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type." }, { "name": "complyToReplicaType", "value": "", "type": "query", "description": "Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well." } ] }, "docs": "Use to retrieve the details of a compute asset by id." }, { "info": { "name": "Update a compute asset.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.run.ai/api/v1/asset/compute/: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 compute asset by id." }, { "info": { "name": "Delete a compute asset.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.run.ai/api/v1/asset/compute/:AssetId", "params": [ { "name": "AssetId", "value": "", "type": "path", "description": "Unique identifier of the asset." } ] }, "docs": "Use to delete a compute asset, by id." } ] } ], "bundled": true }