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.

get

Use to retrieve a list of environment 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.

complyToProjectinteger · int32Optional

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.

complyToWorkloadTypestring · enumOptional

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.

Possible values:

distributedFrameworkstringOptional

Filter results to workload of type distributed and distributedFramework.

isDistributedbooleanOptional

Filter results to workload of type distributed.

isTrainingbooleanOptional

Filter results to workload of type training.

isWorkspacebooleanOptional

Filter results to workload of type workspace.

isInferencebooleanOptional

Filter results to workload of type inference.

complyToReplicaTypestring · enumOptional

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.

Possible values:

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/environment

HTTPcURLJavaScriptPython

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

{
  "entries": []
}

Create an environment asset.

post

Use to create an environment 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/environment

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "args": "-x my-script.py",
    "command": "python",
    "environmentVariables": [
      {
        "name": "HOME",
        "value": "/home/my-folder",
        "credential": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000",
          "key": "POSTGRES_PASSWORD"
        },
        "configMap": {
          "name": "my-config-map",
          "key": "MY_POSTGRES_SCHEMA"
        },
        "podFieldRef": {
          "path": "metadata.name"
        },
        "exclude": false,
        "description": "Home directory of the user."
      }
    ],
    "runAsGid": 30,
    "runAsUid": 500,
    "supplementalGroups": "2,3,5,8",
    "allowPrivilegeEscalation": false,
    "capabilities": [
      "CHOWN",
      "KILL"
    ],
    "createHomeDir": true,
    "hostIpc": false,
    "hostNetwork": false,
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "readOnlyRootFilesystem": false,
    "runAsNonRoot": true,
    "seccompProfileType": "RuntimeDefault",
    "stdin": true,
    "tty": true,
    "uidGidSource": "fromTheImage",
    "workingDir": "/home/myfolder",
    "connections": [],
    "overrideUidGidInWorkspace": false
  }
}

{
  "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": {
    "args": "-x my-script.py",
    "command": "python",
    "environmentVariables": [
      {
        "name": "HOME",
        "value": "/home/my-folder",
        "credential": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000",
          "key": "POSTGRES_PASSWORD"
        },
        "configMap": {
          "name": "my-config-map",
          "key": "MY_POSTGRES_SCHEMA"
        },
        "podFieldRef": {
          "path": "metadata.name"
        },
        "exclude": false,
        "description": "Home directory of the user."
      }
    ],
    "runAsGid": 30,
    "runAsUid": 500,
    "supplementalGroups": "2,3,5,8",
    "allowPrivilegeEscalation": false,
    "capabilities": [
      "CHOWN",
      "KILL"
    ],
    "createHomeDir": true,
    "hostIpc": false,
    "hostNetwork": false,
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "readOnlyRootFilesystem": false,
    "runAsNonRoot": true,
    "seccompProfileType": "RuntimeDefault",
    "stdin": true,
    "tty": true,
    "uidGidSource": "fromTheImage",
    "workingDir": "/home/myfolder",
    "connections": [],
    "overrideUidGidInWorkspace": false
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:47.223Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Get an environment asset.

get

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

complyToProjectinteger · int32Optional

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.

complyToWorkloadTypestring · enumOptional

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.

Possible values:

complyToReplicaTypestring · enumOptional

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.

Possible values:

statusInfobooleanOptional

Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

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/environment/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/environment/{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": {
    "args": "-x my-script.py",
    "command": "python",
    "environmentVariables": [
      {
        "name": "HOME",
        "value": "/home/my-folder",
        "credential": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000",
          "key": "POSTGRES_PASSWORD"
        },
        "configMap": {
          "name": "my-config-map",
          "key": "MY_POSTGRES_SCHEMA"
        },
        "podFieldRef": {
          "path": "metadata.name"
        },
        "exclude": false,
        "description": "Home directory of the user."
      }
    ],
    "runAsGid": 30,
    "runAsUid": 500,
    "supplementalGroups": "2,3,5,8",
    "allowPrivilegeEscalation": false,
    "capabilities": [
      "CHOWN",
      "KILL"
    ],
    "createHomeDir": true,
    "hostIpc": false,
    "hostNetwork": false,
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "readOnlyRootFilesystem": false,
    "runAsNonRoot": true,
    "seccompProfileType": "RuntimeDefault",
    "stdin": true,
    "tty": true,
    "uidGidSource": "fromTheImage",
    "workingDir": "/home/myfolder",
    "connections": [],
    "overrideUidGidInWorkspace": false
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:47.223Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Update an environment asset.

put

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

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

default

unexpected error

application/json

put

/api/v1/asset/environment/{AssetId}

HTTPcURLJavaScriptPython

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

{
  "meta": {
    "name": "my-asset"
  },
  "spec": {
    "args": "-x my-script.py",
    "command": "python",
    "environmentVariables": [
      {
        "name": "HOME",
        "value": "/home/my-folder",
        "credential": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000",
          "key": "POSTGRES_PASSWORD"
        },
        "configMap": {
          "name": "my-config-map",
          "key": "MY_POSTGRES_SCHEMA"
        },
        "podFieldRef": {
          "path": "metadata.name"
        },
        "exclude": false,
        "description": "Home directory of the user."
      }
    ],
    "runAsGid": 30,
    "runAsUid": 500,
    "supplementalGroups": "2,3,5,8",
    "allowPrivilegeEscalation": false,
    "capabilities": [
      "CHOWN",
      "KILL"
    ],
    "createHomeDir": true,
    "hostIpc": false,
    "hostNetwork": false,
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "readOnlyRootFilesystem": false,
    "runAsNonRoot": true,
    "seccompProfileType": "RuntimeDefault",
    "stdin": true,
    "tty": true,
    "uidGidSource": "fromTheImage",
    "workingDir": "/home/myfolder",
    "connections": [],
    "overrideUidGidInWorkspace": false
  }
}

{
  "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": {
    "args": "-x my-script.py",
    "command": "python",
    "environmentVariables": [
      {
        "name": "HOME",
        "value": "/home/my-folder",
        "credential": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000",
          "key": "POSTGRES_PASSWORD"
        },
        "configMap": {
          "name": "my-config-map",
          "key": "MY_POSTGRES_SCHEMA"
        },
        "podFieldRef": {
          "path": "metadata.name"
        },
        "exclude": false,
        "description": "Home directory of the user."
      }
    ],
    "runAsGid": 30,
    "runAsUid": 500,
    "supplementalGroups": "2,3,5,8",
    "allowPrivilegeEscalation": false,
    "capabilities": [
      "CHOWN",
      "KILL"
    ],
    "createHomeDir": true,
    "hostIpc": false,
    "hostNetwork": false,
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "readOnlyRootFilesystem": false,
    "runAsNonRoot": true,
    "seccompProfileType": "RuntimeDefault",
    "stdin": true,
    "tty": true,
    "uidGidSource": "fromTheImage",
    "workingDir": "/home/myfolder",
    "connections": [],
    "overrideUidGidInWorkspace": false
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:47.223Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Delete an environment asset.

delete

Use to delete an environment asset by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

202

Accepted.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

delete

/api/v1/asset/environment/{AssetId}

HTTPcURLJavaScriptPython

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

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