COcomposal
hosting

PATCH /api/v1/hosting/apps/{app_id}/previews/{id}

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/hosting/apps/{app_id}/previews/{id}
  • Auth
    HTTP bearer

Path parameters

app_idstring required
idstring required

Request body

access'org_members' | 'public'
retainedboolean
expires_atstring
expected_generationinteger

Required for resource_overrides, storage_binding_resources, shared_service_binding_ids or shared_data_binding_ids; stale generations return 409.

storage_binding_resourcesobject

Replace preview storage selections, mapping captured mount binding IDs to storage resource IDs. Empty removes mounts. Requires a paused preview and completed cleanup. Shared source local caches and compatible pre-provisioned preview-owned volumes are supported; production single-writer volumes cannot be shared. Source refresh resets selections.

shared_data_binding_idsstring[]

Replace explicitly shared captured native data connections. Empty removes sharing. Requires paused preview and completed cleanup; runtime credentials come only from active managed connection secrets and require workload grants.

shared_service_binding_idsstring[]

Replace the explicitly shared captured service dependencies. Empty removes sharing. Requires paused preview and completed cleanup. Source refresh resets this selection.

resource_overridesPreviewResourceOverrides

Service public IDs mapped to resource overrides. Omitted fields inherit; an empty map removes all local overrides. Null reservations select platform defaults.

Response

Success

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.