Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

NFS

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

List NFS assets.

get

Retrieve a list of NFS datasource assets.

Authorizations
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:
assetIdsstringOptional

Filter results by the ids of the assets. Provided value should be a comma separated string of UUIDs.

Example: dbf4767e-2fa1-43b0-97a2-7c0cecda180b,550e8400-e29b-41d4-a716-44665544000aPattern: ^\b(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})(?:,(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))*\b$
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:
Responses
200

Request completed successfully.

application/json
get/api/v1/asset/datasource/nfs
GET /api/v1/asset/datasource/nfs HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create an NFS asset.

post

Use to create an NFS datasource asset.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

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

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "path": "/container/nfs",
    "readOnly": true,
    "server": "my.nfs.com",
    "mountPath": "/local/nfs"
  }
}
{
  "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": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-01-01T00:00:00.000Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Get an NFS asset.

get

Use to retrieve the details of NFS datasource asset by id.

Authorizations
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:
Responses
200

Request completed successfully.

application/json
get/api/v1/asset/datasource/nfs/{AssetId}
GET /api/v1/asset/datasource/nfs/{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": "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": {
    "path": "/container/nfs",
    "readOnly": true,
    "server": "my.nfs.com",
    "mountPath": "/local/nfs"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-01-01T00:00:00.000Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  }
}

Update an NFS asset.

put

Use to update the details of NFS datasource asset by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body
Responses
202

Request accepted successfully.

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

{
  "meta": {
    "name": "my-asset"
  },
  "spec": {
    "path": "/container/nfs",
    "readOnly": true,
    "server": "my.nfs.com",
    "mountPath": "/local/nfs"
  }
}
{
  "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": {
    "path": "/container/nfs",
    "readOnly": true,
    "server": "my.nfs.com",
    "mountPath": "/local/nfs"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-01-01T00:00:00.000Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  }
}

Delete an NFS asset.

delete

Use to delete an NFS datasource asset by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
202

Accepted.

application/json
codeinteger · min: 100 · max: 599Required
messagestringRequired
delete/api/v1/asset/datasource/nfs/{AssetId}
DELETE /api/v1/asset/datasource/nfs/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Last updated