Run:ai

Environment

An environment resource designates the container image, the image pull policy, working directory, security parameters, and others. It exposes all the necessary tools (open source, 3rd party, or custom tools) along with their connection interfaces including external node port and the container ports. You can also specify a standard, distributed, or inference workload architecture for the environment. An environment is a mandatory building block for the creation of a workload. For more information, see Environments.

List environment assets.

Use to retrieve a list of environment 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"
distributedFramework
string

Filter results to workload of type distributed and distributedFramework.

isDistributed
boolean

Filter results to workload of type distributed.

isTraining
boolean

Filter results to workload of type training.

isWorkspace
boolean

Filter results to workload of type workspace.

isInference
boolean

Filter results to workload of type 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.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/environment
Response samples
application/json
{
  • "entries": [
    ]
}

Create an environment asset.

Use to create an environment asset.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (AssetCreationRequest)
required
object or null (EnvironmentAssetSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

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/environment
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "usageTimes": {
    },
  • "compliance": {
    }
}

Get an environment asset.

Use to retrieve the details of environment 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.

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.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Update an environment asset.

Use to update the details of environment asset by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required
object (AssetUpdateRequest)
required
object or null (EnvironmentAssetSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
202

Request accepted successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

default

unexpected error

put/api/v1/asset/environment/{AssetId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "usageTimes": {
    },
  • "compliance": {
    }
}

Delete an environment asset.

Use to delete an environment asset by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Responses
202

Accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

delete/api/v1/asset/environment/{AssetId}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}
➔ Next to Storage Classes