Sign in
Outline collections

Transition a mirrored collection to a target mirror state (pause / resume)

Changed on

Resuming (PAUSED → ENABLED) resets the sync status to PENDING and kicks a targeted sync; requesting the current state is an idempotent no-op.

patch/workspaces/{workspaceSlug}/outline/collections/{collectionId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/outline/collections/{collectionId}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

collectionIdstring required

Request body

state'ENABLED' | 'PAUSED' required

Target mirror state

Response

Collection state after the transition returned

collectionIdstring required

Outline collection id (UUID; the natural key)

colorstring

Collection color as configured in Outline

createdAtstring date-time required

When the collection was registered for mirroring

descriptionstring

Collection description as shown in Outline

documentCountinteger required

Live (non-tombstoned) mirrored document count

documentsUpstreaminteger

Documents upstream reported for this collection at the last enumeration (coverage denominator)

exportsSkippedForBudgetinteger

Exports the last pass skipped because the shared budget ran out (0 on a clean pass)

iconstring

Collection icon as configured in Outline

idinteger required

Internal registry row id

lastSyncErrorstring

Last sync failure for this collection, cleared on the next clean pass

lastSyncedAtstring date-time

When this collection last completed a full reconcile pass, if any

namestring

Collection name as shown in Outline, if known

state'ENABLED' | 'PAUSED' required

Mirror lifecycle state (PAUSED freezes sync but keeps documents)

syncStatus'PENDING' | 'COMPLETE' required

Whether a clean full pass has completed since registration or the last resume

urlIdstring

Outline url id (the short slug in collection URLs)

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$