Sign in
Images

Set default image

⚠️ This endpoint is in public preview.

Set a public image as the default. The image must have provider = 'sfc'. Atomically swaps the default from any previous default image to this one. Requires admin permissions.

post/preview/v2/admin/images/{id}/set-default

Path parameters

idstring required
Example:image_k3R-nX9vLm7Qp2Yw5Jd8F

Image ID

Response

Default image set

idstring required
resource_pathstring required

A resource path for a image resource. Format: sfc:image:<account>:<workspace>:<name>.

ownerstring required
workspacestring required
namestring required
object'image' required
upload_status'started' | 'uploading' | 'completed' | 'failed' | 'revoked' required
created_atinteger required

Unix timestamp.

providerstring nullable
sha256string nullable
is_defaultboolean required

Example response

{
  "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:image:<account_id>:<workspace>:<name>",
  "owner": "my-resource-name",
  "workspace": "my-resource-name",
  "name": "my-resource-name",
  "object": "image",
  "created_at": 1738972800
}

Changes

Changed in 2 of the 44 revisions of this API.11