Datasources

Data source assets.

List datasource assets.

Returns a combined list of data-sources.

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.
complyToProject	integer <int32> Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.
complyToWorkloadType	string Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type. Enum: "Workspace" "Training" "Distributed" "Inference"
statusInfo	boolean Whether the query should include asset status information as part of the response.
assetIds	string^\b(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-... Filter results by the ids of the assets. Provided value should be a comma separated string of UUIDs. Example: assetIds=dbf4767e-2fa1-43b0-97a2-7c0cecda180b,550e8400-e29b-41d4-a716-44665544000a
complyToReplicaType	string Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well. Enum: "Worker" "Master"

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/datasource

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": {"hostPath": {"path": "/container/directory",
"readOnly": true,
"mountPath": "/local/directory",
"mountPropagation": "None"
},
"nfs": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
},
"pvc": {"existingPvc": false,
"claimName": "my-claim",
"path": "/container/my-claim",
"readOnly": false,
"ephemeral": false,
"claimInfo": {"size": "1G",
"storageClass": "my-storage-class",
"accessModes": {"readWriteOnce": true,
"readOnlyMany": false,
"readWriteMany": false
},
"volumeMode": "Filesystem"
}
},
"git": {"repository": "https://github.com/my-git/my-repo",
"branch": "main",
"revision": "string",
"path": "/container/my-repository",
"passwordAssetId": "ea378b04-bd66-4a2b-b4ab-0613ae9c5789"
},
"s3": {"bucket": "my-bucket",
"path": "/container/my-bucket",
"url": "https://s3.amazonaws.com",
"accessKeyAssetId": "85754ae3-3c5c-44f4-b3c9-d15423577c51"
},
"config_map": {"configMap": "string",
"mountPath": "string"
},
"secret": {"credentialAssetId": "465e272b-1a7e-43a0-ab51-3a26486e5f7d",
"mountPath": "string"
}
},
"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"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"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"
}
}
]
}

➔ Next to Environment