Run:ai

HostPath

Use a HostPath as a data source location for data sets that are relevant to the workload being submitted.

List host path assets.

Retrieve a list of hostPath datasource 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.

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"
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.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/datasource/host-path
Response samples
application/json
{
  • "entries": [
    ]
}

Create a host path asset.

Use to create a hostPath datasource asset.

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (AssetCreationRequest)
required
object or null (HostPathSpec)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/datasource/host-path
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "usageTimes": {
    },
  • "compliance": {
    }
}

Get a hostPath asset.

Use to retrieve the details of a hostPath datasource 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.

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"
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.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/datasource/host-path/{AssetId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "usageTimes": {
    },
  • "compliance": {
    }
}

Update a hostPath asset.

Use to update the details of a hostPath datasource 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)
required
object or null (HostPathSpec)
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/datasource/host-path/{AssetId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "usageTimes": {
    },
  • "compliance": {
    }
}

Delete a hostPath asset.

Use to delete a hostPath datasource asset 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/datasource/host-path/{AssetId}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}
➔ Next to NFS