Version 2.23 is deprecated. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Credentials

Credentials are used to unlock protected resources such as applications, containers, and other assets. For more information, see Credentials.

List credentials.

get

Use to retrieve a list of all existing credentials.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

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

{
  "entries": []
}

List access keys.

get

Use to retrieve a list of S3-compatible access key credentials.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/access-key
GET /api/v1/asset/credentials/access-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create an access key.

post

Use to create an S3-compatible access key credential.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

application/json
post/api/v1/asset/credentials/access-key
POST /api/v1/asset/credentials/access-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get an access key.

get

Use to retrieve the details of an S3-compatible access key credential 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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/access-key/{AssetId}
GET /api/v1/asset/credentials/access-key/{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": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update an access key.

put

Use to update the details of an S3-compatible access key credential 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/credentials/access-key/{AssetId}
PUT /api/v1/asset/credentials/access-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "accessKeyId": "text",
    "secretAccessKey": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete an access key.

delete

Use to delete an S3-compatible access key credential 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/credentials/access-key/{AssetId}
DELETE /api/v1/asset/credentials/access-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List password credentials.

get

Use to retrieve a list of password credentials.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

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

{
  "entries": []
}

Create a userid / password credential.

post

Use to create a userid / password credential.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

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

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a userid / password credential.

get

Use to retrieve the details of a userid / password credential 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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/password/{AssetId}
GET /api/v1/asset/credentials/password/{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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a password credential.

put

Use to Update the details of a password credential 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/credentials/password/{AssetId}
PUT /api/v1/asset/credentials/password/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a password asset.

delete

Udse to delete a password credential 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/credentials/password/{AssetId}
DELETE /api/v1/asset/credentials/password/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List docker registry credentials.

get

Use to retrieve a list of docker registry credentials.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/docker-registry
GET /api/v1/asset/credentials/docker-registry HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a docker registry credential.

post

Use to create a docker registry credential containing userid, password and url.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

application/json
post/api/v1/asset/credentials/docker-registry
POST /api/v1/asset/credentials/docker-registry HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a docker registry credential.

get

Use to retrieve the details of a docker registry credential 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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/docker-registry/{AssetId}
GET /api/v1/asset/credentials/docker-registry/{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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a docker registry credential.

put

Use to updates the details of a docker registry credentials 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/credentials/docker-registry/{AssetId}
PUT /api/v1/asset/credentials/docker-registry/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "user": "text",
    "password": "text",
    "url": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a docker registry credential.

delete

Use to deletes a docker registry credential 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/credentials/docker-registry/{AssetId}
DELETE /api/v1/asset/credentials/docker-registry/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List generic-secrets.

get

Retrieve a list of generic-secret assets.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/generic-secret
GET /api/v1/asset/credentials/generic-secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a generic-secret.

post

Use to create a generic-secret asset.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

application/json
post/api/v1/asset/credentials/generic-secret
POST /api/v1/asset/credentials/generic-secret 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": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ]
  }
}
{
  "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": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a generic-secret.

get

Returns the details of a generic-secret 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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/generic-secret/{AssetId}
GET /api/v1/asset/credentials/generic-secret/{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": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a generic-secret.

put

Updates the details of a generic-secret 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/credentials/generic-secret/{AssetId}
PUT /api/v1/asset/credentials/generic-secret/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}
{
  "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": {
    "existingSecretName": "text",
    "keyValuePairs": [
      {
        "key": "secret-key",
        "value": "my-secret"
      }
    ],
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a generic-secret.

delete

Use to delete a generic-secret asset, by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
204

No Content.

No content
delete/api/v1/asset/credentials/generic-secret/{AssetId}
DELETE /api/v1/asset/credentials/generic-secret/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List ngc-api-keys.

get

Retrieve a list of ngcApiKey assets.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/ngc-api-key
GET /api/v1/asset/credentials/ngc-api-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create a ngc-api-key.

post

Use to create a ngc-api-key asset.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
202

Request accepted successfully.

application/json
post/api/v1/asset/credentials/ngc-api-key
POST /api/v1/asset/credentials/ngc-api-key HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "ngc_api_key": "text"
  }
}
{
  "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": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Get a ngc-api-key.

get

Returns the details of a ngc-api-key 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.

statusInfobooleanOptional

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

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/credentials/ngc-api-key/{AssetId}
GET /api/v1/asset/credentials/ngc-api-key/{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": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Update a ngc-api-key.

put

Updates the details of a ngc-api-key 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/credentials/ngc-api-key/{AssetId}
PUT /api/v1/asset/credentials/ngc-api-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "meta": {
    "description": "my-credentials"
  }
}
{
  "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": {
    "ngc_api_key": "text",
    "keyId": 1
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  },
  "clusterInfo": {
    "resources": [
      {
        "name": "password-credential-1"
      }
    ]
  }
}

Delete a ngc-api-key.

delete

Use to delete a ngc-api-key asset, by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
204

No Content.

No content
delete/api/v1/asset/credentials/ngc-api-key/{AssetId}
DELETE /api/v1/asset/credentials/ngc-api-key/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousCompute
NextDatasources

Last updated