Skip to main content
PATCH
Rename an ISO

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

iso
string
required

The iso UUID

Example:

"ec4fa5b5-cc7c-4fcf-b280-ee55eca8d44b"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

name
string
required

The name shown to customers.

Required string length: 1 - 40

Response

The record, as a JSON object. There is no envelope.

An ISO image stored for the customer.

uuid
string
required

The uuid UUID.

Example:

"ec4fa5b5-cc7c-4fcf-b280-ee55eca8d44b"

name
string
required

The name shown to customers.

Example:

"Ubuntu 24.04.1 Live Server"

file_name
string | null
required

The value of file_name.

Example:

"client-67d74fbd-2dc5-4f95-a946-c504a98f59fb-pASjFJotP7rB.iso"

size
integer | null
required

The value of size.

Example:

2774532096

is_successful
boolean | null
required

Null until the download finishes, which is a third state and not a failure: a row created the moment a fetch is queued has never been written to. Published as null and kept that way.

Example:

true

status
enum<string>
required

The value of status.

Available options:
downloading,
failed,
ready
Example:

"ready"

is_preparing
boolean
required

The download has finished and the image is being prepared for mounting.

Example:

false

mounted_server_count
integer
required

The total number of servers using this image, including servers outside the current team. The image cannot be deleted while mounted.

Example:

1

mounted_on_this_server
boolean
required

The value of mounted_on_this_server.

Example:

true

mounted_on_other_servers_count
integer
required

The number of mounted on other servers count.

Example:

0

mounted_servers
IsoMountedServerData · object[]
required

Visible servers using this image. Empty without deletion permission. The mount count may be higher because it includes inaccessible servers.

Example:
can_delete
boolean
required

Whether the customer can delete.

Example:

true

owned_by_server_owner
boolean
required

False only for a member of staff's own image showing up on a customer's server. Account-level listings are all the viewer's own, so nothing there is ever flagged.

Example:

true

completed_at
string | null
required

A string, not a date object, and deliberately so: the column carries no datetime cast, so this has always gone out as MySQL wrote it ("2026-08-19 18:20:41") rather than in the ISO-8601 form created_at below uses. Two formats in one payload is not a design, it is what is published, and changing it would move a date under every caller that parses it.

Example:

"2026-09-10 13:27:41"

created_at
string<date-time> | null
required

The date and time for created at, in UTC.

Examples:

"2026-09-03T04:21:17.000000Z"

"2026-09-10T13:25:01.000000Z"

download_progress
integer
required

Percent, and zero rather than null while nothing has started.

Example:

100

download_started_at
string<date-time> | null
required

The date and time for download started at, in UTC.

Examples:

"2026-09-03T04:21:17.000000Z"

"2026-09-10T13:25:04.000000Z"