Credentials

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

List credentials.

Use to retrieve a list of all existing credentials.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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 both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials

Response samples

application/json

{"entries": [{"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": {"accessKey": {"existingSecretName": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"keyId": 0
},
"password": {"existingSecretName": "string",
"user": "string",
"password": "string",
"keyId": 0
},
"dockerRegistry": {"existingSecretName": "string",
"user": "string",
"password": "string",
"url": "string",
"keyId": 0
},
"genericSecret": {"existingSecretName": "string",
"keyValuePairs": [{"key": "secret-key",
"value": "my-secret"
}
],
"keyId": 0
}
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}
]
}

List access keys.

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

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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 both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

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

Response samples

application/json

{"entries": [{"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": {"existingSecretName": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}
]
}

Create an access key.

Use to create an S3-compatible access key credential.

SecuritybearerAuth

Request

Request Body schema: application/json
required

required	object (AssetCreationRequest)
required	object (AccessKeyCreationSpec)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

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

Request samples

Payload

application/json

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Get an access key.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

query Parameters

usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Update an access key.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required

required

object (AssetUpdateRequest)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
}
}

Response samples

application/json

{"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": {"existingSecretName": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Delete an access key.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

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

Response samples

application/json

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

List password credentials.

Use to retrieve a list of password credentials.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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 both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials/password

Response samples

application/json

{"entries": [{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}
]
}

Create a userid / password credential.

Use to create a userid / password credential.

SecuritybearerAuth

Request

Request Body schema: application/json
required

required	object (AssetCreationRequest)
required	object (PasswordCreationSpec)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/credentials/password

Request samples

Payload

application/json

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Get a userid / password credential.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

query Parameters

usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Update a password credential.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required

required

object (AssetUpdateRequest)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
}
}

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Delete a password asset.

Udse to delete a password credential by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

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

Response samples

application/json

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

List docker registry credentials.

Use to retrieve a list of docker registry credentials.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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 both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

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

Response samples

application/json

{"entries": [{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"url": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}
]
}

Create a docker registry credential.

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

SecuritybearerAuth

Request

Request Body schema: application/json
required

required	object (AssetCreationRequest)
required	object (DockerRegistryCreationSpec)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

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

Request samples

Payload

application/json

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"url": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Get a docker registry credential.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

query Parameters

usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"url": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Update a docker registry credential.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required

required

object (AssetUpdateRequest)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
}
}

Response samples

application/json

{"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": {"existingSecretName": "string",
"user": "string",
"password": "string",
"url": "string",
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Delete a docker registry credential.

Use to deletes a docker registry credential by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

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

Response samples

application/json

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

List generic-secrets.

Retrieve a list of generic-secret assets.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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 both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

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

Response samples

application/json

{"entries": [{"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": {"existingSecretName": "string",
"keyValuePairs": [{"key": "secret-key",
"value": "my-secret"
}
],
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}
]
}

Create a generic-secret.

Use to create a generic-secret asset.

SecuritybearerAuth

Request

Request Body schema: application/json
required

required	object (AssetCreationRequest)
required	object (GenericSecretCreationSpec)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

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

Request samples

Payload

application/json

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"keyValuePairs": [{"key": "secret-key",
"value": "my-secret"
}
],
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Get a generic-secret.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

query Parameters

usageInfo	boolean Whether the query should include asset usage information as part of the response.
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"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": {"existingSecretName": "string",
"keyValuePairs": [{"key": "secret-key",
"value": "my-secret"
}
],
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Update a generic-secret.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required

required

object (AssetUpdateRequest)

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
}
}

Response samples

application/json

{"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": {"existingSecretName": "string",
"keyValuePairs": [{"key": "secret-key",
"value": "my-secret"
}
],
"keyId": 0
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
},
"clusterInfo": {"resources": [{"name": "password-credential-1"
}
]
}
}

Delete a generic-secret.

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

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

204

No Content.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

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

Response samples

application/json

{"code": 400,
"message": "Required parameter is missing"
}

➔ Next to Datasources

Credentials

List credentials.

query Parameters

List access keys.

query Parameters

Create an access key.

Request Body schema: application/jsonrequired

Get an access key.

path Parameters

query Parameters

Update an access key.

path Parameters

Request Body schema: application/jsonrequired

Delete an access key.

path Parameters

List password credentials.

query Parameters

Create a userid / password credential.

Request Body schema: application/jsonrequired

Get a userid / password credential.

path Parameters

query Parameters

Update a password credential.

path Parameters

Request Body schema: application/jsonrequired

Delete a password asset.

path Parameters

List docker registry credentials.

query Parameters

Create a docker registry credential.

Request Body schema: application/jsonrequired

Get a docker registry credential.

path Parameters

query Parameters

Update a docker registry credential.

path Parameters

Request Body schema: application/jsonrequired

Delete a docker registry credential.

path Parameters

List generic-secrets.

query Parameters

Create a generic-secret.

Request Body schema: application/jsonrequired

Get a generic-secret.

path Parameters

query Parameters

Update a generic-secret.

path Parameters

Request Body schema: application/jsonrequired

Delete a generic-secret.

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required