images

Point a tag of the image's name at this version, moving it from wherever it was.

post/v1/images/{id}:tag

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/images/{id}:tag
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

tagstring required

Response

Success

idstring required
kind'image' required
statusstring required
state'queued' | 'building' | 'ready' | 'failed' | 'deleting' | 'deleted' required
namestring nullable
versioninteger nullable
tagsstring[]
sizeBytesinteger nullable

The image's whole file, once it is ready. Its storage is charged on this.

sizeMiBinteger nullable
storedBytesinteger nullable

The part of the file that shares nothing with other files on its server, measured when it was built; often 0, since an image is built on a shared base. Not what it is charged on: sizeBytes is.

errorstring nullable
createdAtstring

Changes

No recorded changes to this operation across all 1 revision of this API.