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

Registry

Use an images registry to enable the listting of repositories and tags that can be used as a data source location for data sets that are relevant to the workload being submitted.

Get registries.

get

Retrieve a list of registries assets.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

Responses
200

Request completed successfully.

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

{
  "entries": []
}

Create a registry asset.

post

Use to create a registry asset containing a registry base url and credentials.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
201

Request accepted successfully.

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

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "url": "https://hub.docker.com/",
    "credentialKind": "password",
    "user": "admin",
    "password": 12345678
  }
}
{
  "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": {
    "url": "https://hub.docker.com/",
    "credentialKind": "password",
    "user": "admin",
    "password": 12345678
  }
}

Get a registry.

get

Retrieve a registry asset by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
200

Request completed successfully.

application/json
get/api/v1/asset/registries/{AssetId}
GET /api/v1/asset/registries/{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": {
    "url": "https://hub.docker.com/",
    "credentialKind": "password",
    "user": "admin",
    "password": 12345678
  }
}

Update a registry asset.

put

Use to update a registry asset containing registry base url and credentials by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body
Responses
200

Request accepted successfully.

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

{
  "meta": {
    "name": "my-asset"
  }
}
{
  "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": {
    "url": "https://hub.docker.com/",
    "credentialKind": "password",
    "user": "admin",
    "password": 12345678
  }
}

Delete a registry asset.

delete

Use to delete a registry asset containing registry base url and credentials by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
204

Registry has been deleted.

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

No content

Get the repositories in the registry.

get

Retrieve a list of repositories from a registry asset.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Query parameters
searchNamestringOptional

Filter results that contains searchName.

Responses
200

Request completed successfully.

application/json
repositoriesstring[]Required
get/api/v1/asset/registries/{AssetId}/repositories
GET /api/v1/asset/registries/{AssetId}/repositories HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "repositories": [
    "text"
  ]
}

Get the repositories tags in the registry.

get

Retrieve a list of repository tags from a repository asset.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Query parameters
repositorystringRequired

The repository name that its tags are requested.

searchNamestringOptional

Filter results that contains searchName.

Responses
200

Request completed successfully.

application/json
namestringRequired
tagsstring[]Required
get/api/v1/asset/registries/{AssetId}/repositories/tags
GET /api/v1/asset/registries/{AssetId}/repositories/tags?repository=text HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "tags": [
    "text"
  ]
}
PreviousPVCNextS3

Last updated