Credentials

Credentials are used to unlock protected resources such as applications, containers, and other assets. For more information, see Credentials.

List credentials.

get

Use to retrieve a list of all existing credentials.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

includeDescendantsbooleanOptional

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.

Responses

200

Request completed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

List access keys.

get

Use to retrieve a list of S3-compatible access key credentials.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/access-key

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/access-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create an access key.

post

Use to create an S3-compatible access key credential.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/asset/credentials/access-key

HTTPcURLJavaScriptPython

POST /api/v1/asset/credentials/access-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get an access key.

get

Use to retrieve the details of an S3-compatible access key credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/access-key/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/access-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update an access key.

put

Use to update the details of an S3-compatible access key credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/api/v1/asset/credentials/access-key/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/credentials/access-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete an access key.

delete

Use to delete an S3-compatible access key credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

202

Accepted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

412

The specified resource was not found.

application/json

503

unexpected error

application/json

delete

/api/v1/asset/credentials/access-key/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/credentials/access-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}

List password credentials.

get

Use to retrieve a list of password credentials.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/password

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a userid / password credential.

post

Use to create a userid / password credential.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/asset/credentials/password

HTTPcURLJavaScriptPython

POST /api/v1/asset/credentials/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a userid / password credential.

get

Use to retrieve the details of a userid / password credential asset by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/password/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/password/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a password credential.

put

Use to Update the details of a password credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/api/v1/asset/credentials/password/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/credentials/password/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a password asset.

delete

Udse to delete a password credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

202

Accepted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

412

The specified resource was not found.

application/json

503

unexpected error

application/json

delete

/api/v1/asset/credentials/password/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/credentials/password/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}

List docker registry credentials.

get

Use to retrieve a list of docker registry credentials.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/docker-registry

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/docker-registry HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a docker registry credential.

post

Use to create a docker registry credential containing userid, password and url.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/asset/credentials/docker-registry

HTTPcURLJavaScriptPython

POST /api/v1/asset/credentials/docker-registry HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a docker registry credential.

get

Use to retrieve the details of a docker registry credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/docker-registry/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/docker-registry/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a docker registry credential.

put

Use to updates the details of a docker registry credentials by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/api/v1/asset/credentials/docker-registry/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/credentials/docker-registry/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a docker registry credential.

delete

Use to deletes a docker registry credential by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

202

Accepted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

412

The specified resource was not found.

application/json

503

unexpected error

application/json

delete

/api/v1/asset/credentials/docker-registry/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/credentials/docker-registry/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}

List generic-secrets.

get

Retrieve a list of generic-secret assets.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/generic-secret

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/generic-secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a generic-secret.

post

Use to create a generic-secret asset.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/asset/credentials/generic-secret

HTTPcURLJavaScriptPython

POST /api/v1/asset/credentials/generic-secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ]
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a generic-secret.

get

Returns the details of a generic-secret asset, by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/generic-secret/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/generic-secret/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a generic-secret.

put

Updates the details of a generic-secret asset, by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/api/v1/asset/credentials/generic-secret/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/credentials/generic-secret/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a generic-secret.

delete

Use to delete a generic-secret asset, by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

204

No Content.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

412

The specified resource was not found.

application/json

503

unexpected error

application/json

delete

/api/v1/asset/credentials/generic-secret/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/credentials/generic-secret/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List ngc-api-keys.

get

Retrieve a list of ngcApiKey assets.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

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.

departmentIdstringOptional

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.

Example: 1

clusterIdstring · uuidOptional

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/ngc-api-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a ngc-api-key.

post

Use to create a ngc-api-key asset.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v1/asset/credentials/ngc-api-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "ngc_api_key": "text"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a ngc-api-key.

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

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.

Responses

200

Request completed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/credentials/ngc-api-key/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/credentials/ngc-api-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a ngc-api-key.

put

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

/api/v1/asset/credentials/ngc-api-key/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/credentials/ngc-api-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a ngc-api-key.

delete

Use to delete a ngc-api-key asset, by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

204

No Content.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

412

The specified resource was not found.

application/json

503

unexpected error

application/json

delete

/api/v1/asset/credentials/ngc-api-key/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/credentials/ngc-api-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content