Skip to content

Docker images

Manages the docker images used by the worker nodes.

Fields#

  • pk: int (primary key of the Docker image)
  • name: str
  • version: str
  • url: str
  • registry_url: str (URL)
  • registry_username: str or null (null if registry doesn't require login)
  • registry_password: str or null (null if registry doesn't require login)
  • cuda_version: JSON representation of the Docker image's CUDA version
  • framework: JSON representation of the Docker image's framework
  • domain: str (long-name of the domain the Docker image operates in)
  • tasks: array of str (names of job-contracts that the Docker image can be used with e.g. Train/Predict/...)
  • min_hardware_generation: JSON representation of the Docker image's minimum required hardware generation or null
  • cpu: bool (works on CPU only?)
  • licence: str (name of the Docker image's license)

Actions#

List#

Lists the Docker images present on the server.

Method#

POST

URL#

/v1/docker/list

Permissions#
Body (optional)#
Response#
  • A JSON array of objects containing each Docker image's fields

Create#

Creates a new Docker image.

Method#

POST

URL#

/v1/docker/create

Body#
  • name: str
  • version: str
  • url: str
  • registry_url: str (URL)
  • registry_username: str or null (null if registry doesn't require login)
  • registry_password: str or null (null if registry doesn't require login)
  • cuda_version: str (CUDA version-string)
  • framework: int (framework primary-key)
  • domain: str (name of the domain the Docker image operates in)
  • tasks: array of str (names of job-contracts that the Docker image can be used with e.g. Train/Predict/...)
  • min_hardware_generation: (minimum required hardware generation-string) or null
  • cpu: bool (works on CPU only?)
  • licence: str (name of the Docker image's license)
Permissions#
Response#
  • A JSON object containing the newly-created Docker image's fields

Retrieve#

Gets the information about a specific Docker image.

Method#

GET

URL#

/v1/docker/{PK}

Parameters#
  • PK: int (primary key of Docker image)
Permissions#
Response#
  • A JSON object containing the Docker image's fields

Update#

Updates a specific Docker image.

Method#

PUT

URL#

/v1/docker/{PK}

Parameters#
  • PK: int (primary key of Docker image)
Body#

  • JSON object containing:

    • name: str
    • version: str
    • url: str
    • registry_url: str (URL)
    • registry_username: str or null (null if registry doesn't require login)
    • registry_password: str or null (null if registry doesn't require login)
    • cuda_version: str (CUDA version-string)
    • framework: int (framework primary-key)
    • domain: str (name of the domain the Docker image operates in)
    • tasks: array of str (names of job-contracts that the Docker image can be used with e.g. Train/Predict/...)
    • min_hardware_generation: (minimum required hardware generation-string) or null
    • cpu: bool (works on CPU only?)
    • licence: str (name of the Docker image's license)
Permissions#
Response#
  • A JSON object containing the updated job's fields

Partial Update#

Updates a specific Docker image.

Method#

PATCH

URL#

/v1/docker/{PK}

Parameters#
  • PK: int (primary key of Docker image)
Body#

  • JSON object containing:

    • name (optional): str
    • version (optional): str
    • url (optional): str
    • registry_url (optional): str (URL)
    • registry_username (optional): str or null (null if registry doesn't require login)
    • registry_password (optional): str or null (null if registry doesn't require login)
    • cuda_version (optional): str (CUDA version-string)
    • framework (optional): int (framework primary-key)
    • domain (optional): str (name of the domain the Docker image operates in)
    • tasks (optional): array of str (names of job-contracts that the Docker image can be used with e.g. Train/Predict/...)
    • min_hardware_generation (optional): (minimum required hardware generation-string) or null
    • cpu (optional): bool (works on CPU only?)
    • licence (optional): str (name of the Docker image's license)
Permissions#
Response#
  • A JSON object containing the updated Docker image's fields

Destroy#

Attempts to delete a Docker image from the server. The Docker image will only be deleted if no references are held to it by other models on the server.

Method#

DELETE

URL#

/v1/docker/{PK}

Parameters#
  • PK: int (primary key of job)
Permissions#