Update app image

Update an installable app's name, its texts, or whether it is in the public catalogue. The slug is the address and cannot be changed.

patch/api/app-images/{handle}/{slug}

Request

  • Base URL: https://reduck.ai
  • URL: https://reduck.ai/api/app-images/{handle}/{slug}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

handlestring required

The owner a resource is addressed under: "@username" for a personal scope, or a bare slug for a project.

slugstring required

The image's identifier within its owner's scope. Chosen once and never changed.

Request body

namestring

A display name. Images are addressed by slug, so this is free to change.

visibility'private' | 'public'

private is the owning scope; public lists it in the catalogue, where any signed-in account may install it. Publishing exposes the artefact, never anyone's data.

descriptionstring

The one-line summary, carried in every listing unlike about. Send "" to clear it.

aboutstring

Long-form text about the image, not carried in listings. Send "" to clear it.

Response

OK

idstring required
slugstring required

The second half of the address, under owner.handle. Chosen at creation and never changes.

namestring required
descriptionstring required

The one-line summary, carried in every listing unlike about. Empty until one is written.

visibility'private' | 'public' required
current_releasenumber nullable required

The release every app of this image serves, null until the first deploy.

released_atstring nullable required

When the served release shipped, null while there is none.

archived_atstring nullable required

Archived images stay installed and running, but take no new installs and are listed nowhere.

install_countnumber required

How many apps run this image, across every scope. What an archive has to answer for.

created_atstring required
updated_atstring required
aboutstring required

Long-form text about the image, empty until written. Answered exactly as written, so whatever renders it decides whether it is markdown.

api_grantunknown required
config_defaultsunknown required
release_countnumber required

Changes

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