Get a ngc-api-key.

GET

http://localhost:8080/api/v1/asset/credentials/ngc-api-key/:AssetId

GET

/api/v1/asset/credentials/ngc-api-key/:AssetId

curl http://localhost:8080/api/v1/asset/credentials/ngc-api-key/AssetId \
     -H "Authorization: Bearer <token>"

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "test@run.ai",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "test@run.ai",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "keyId": 1,
    "ngc_api_key": "string"
  },
  "usedBy": {
    "workspaces": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "trainings": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "distributed": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "inferences": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "templates": [
      {
        "id": "string",
        "name": "my-asset"
      }
    ],
    "assets": {
      "environment": {
        "id": "string",
        "name": "my-asset",
        "toolTypes": [
          "jupyter-notebook"
        ]
      },
      "environments": [
        {
          "id": "string",
          "name": "my-asset"
        }
      ],
      "compute": {
        "id": "string",
        "name": "my-asset"
      },
      "computes": [
        {
          "id": "string",
          "name": "my-asset"
        }
      ],
      "datasources": [
        {
          "id": "string",
          "name": "my-asset",
          "kind": "compute",
          "overrides": {
            "containerPath": "/container/directory"
          }
        }
      ]
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": [
      {
        "details": "string",
        "field": "string",
        "rule": "min"
      }
    ]
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "string",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "string",
    "url": "string"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Returns the details of a ngc-api-key asset, by id.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

AssetIdstringRequiredformat: "uuid">=1 character

Unique identifier of the asset.

Query parameters

usageInfobooleanOptional

Whether the query should include asset usage information as part of the response.

statusInfobooleanOptional

Whether the query should include asset status information as part of the response.

Response

Request completed successfully.

metaobject

specobject

usedByobjectOptional

Details about resources that use the asset.

complianceobjectOptional

Compliance of an asset with creation of workloads in a given project.

statusobjectOptional

clusterInfoobjectOptional

Cluster related information of the asset.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error