Skip to Content
kosemdocs
ReferenceAPIEnvironments

Update image in organization

Changes an image's display name, the projects an organization's image is shared with, whether it follows its tag, or how many versions it keeps.

PATCH
/v1/organizations/{organization}/images/{image}

Changes an image's display name, the projects an organization's image is shared with, whether it follows its tag, or how many versions it keeps.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

organization*string

The organization's ID.

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$
image*string

The image's ID.

Match^img_[0-7][0-9a-hjkmnp-tv-z]{25}$

Request Body

application/json
  1. body
availability?

For an organization's image: the projects whose environments use it. Changing it also takes environments.images.setAvailability, and applies from their next starts.

displayName?string

What people call the image.

Length1 <= length <= 100
followTag?boolean

Whether kosem resolves its tag again every hour.

keepVersions?integer

How many of its newest versions it keeps, from 1 to 10. Lowering it deletes the older ones that no environment runs.

Formatint32
Range1 <= value <= 10

Response Body

OK

application/json
  1. response
availability*

For an organization's image: the projects whose environments use it. A project's image is available to none.

checkTime?string

When kosem last resolved its source; unset until it has.

Formatdate-time
createTime*string

When the image was created.

Formatdate-time
displayName*string

What people call the image.

followTag*boolean

Whether kosem resolves its tag again every hour, as RefreshImage does, so that it prepares each new version. A source named by a digest never moves.

keepVersions*integer

How many of its newest versions it keeps. An older one is deleted once no environment runs it.

Formatint32
name*string

Resource name, organizations/{organization_id}/images/{image_id} or projects/{project_id}/images/{image_id}.

refreshReason*string

Why kosem's last check of its tag couldn't refresh it, which leaves it as it was; empty once a check can.

registry?string

The registry that kosem signs in with to pull it, when it's private.

source*string

The image's reference, with a tag or a digest, in its shortest spelling, such as node:24 for docker.io/library/node:24. Set when the image is created, and never changed.

state*string

PREPARING until its latest version is ready to run, READY once it is, and FAILED if kosem can't prepare it.

Value in"PREPARING""READY""FAILED"
stateReason*string

Why kosem can't prepare it, when it can't.

updateTime*string

When the image last changed.

Formatdate-time
versions*array<>

What its source named each time it was resolved, newest first.

Example Request
curl -X PATCH 'https://api.kosem.ai/v1/organizations/string/images/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "availability": {
    "allProjects": true,
    "projects": [
      "string"
    ]
  },
  "checkTime": "2019-08-24T14:15:22Z",
  "createTime": "2019-08-24T14:15:22Z",
  "displayName": "string",
  "followTag": true,
  "keepVersions": 0,
  "name": "string",
  "refreshReason": "string",
  "registry": "string",
  "source": "string",
  "state": "PREPARING",
  "stateReason": "string",
  "updateTime": "2019-08-24T14:15:22Z",
  "versions": [
    {
      "createTime": "2019-08-24T14:15:22Z",
      "digest": "string",
      "environments": 0,
      "prepareTime": "2019-08-24T14:15:22Z",
      "sizeBytes": 0
    }
  ]
}