sandbox-custom-images
sandbox_custom_images

Rename or update the description of a custom image. Only mutable metadata (name, description) is editable; the build spec and status are managed by the build flow.

patch/api/projects/{project_id}/sandbox_custom_images/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/sandbox_custom_images/{id}/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

namestring

New display name for the custom image. Omit to leave unchanged.

descriptionstring

New description. Omit to leave unchanged; pass an empty string to clear it.

Response

idstring uuid required
namestring required
descriptionstring required
repositorystring
privateboolean
statusstring required
versioninteger required
modal_image_namestring required
specobject
spec_yamlstring
scan_resultobject
build_logstring
errorstring required
builder_task_idstring uuid nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

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