Archive document

Outcome

Archive a native document and remove its publication pointer.

These examples were captured from the local Worker. Deployment, publication and retrieval are verified separately for each environment; local examples do not establish external provider delivery.

Before you start

• Inspect the credential identity with topolo whoami and the exact action with topolo actions get before preparing input.

• Discover an accessible Docs workspace with topolo resources topolo-docs and topolo workspaces list topolo-docs. Pass workspace resource type and identifier separately from action input.

• The published required permission is docs:write; the active credential and resource binding must authorize the call.

• Validate and plan the exact request. Execute only after the intended effect has been authorized; --confirm is the transport guard, not a grant of permission.

Discover the target

topolo actions get app_topolo_docs.documents.archive --detail --json
topolo resources topolo-docs --json
topolo workspaces list topolo-docs --json
Discover documentId with app_topolo_docs.documents.list.

Input fields

Interpret the response

documentId identifies the successfully archived document; ok acknowledges archiving and removal of the public publication pointer. Version history remains stored. The native metadata update route cannot restore an archived document.

Worked examples

The following inputs and responses were captured from the local Docs worker fixture. Auth and Nexus dependencies are simulated. Identifiers, URLs and timestamps are illustrative fixture values. Discover your own identifiers and choose an appropriate test resource; copying a fixture identifier does not make it valid in your environment. For workspace-bound calls, set DOCS_WORKSPACE_ID to the identifier returned by resource discovery. Run validation and planning first; the final call requires the intended effect to be authorized.

Minimal example

Save the input as payload.json:

{
  "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4"
}

CLI:

topolo actions validate app_topolo_docs.documents.archive --data @payload.json --json
topolo actions plan app_topolo_docs.documents.archive --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.documents.archive --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_docs.documents.archive",
    "input": {
      "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true,
  "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4"
}

documentId identifies the successfully archived document; ok acknowledges archiving and removal of the public publication pointer. Version history remains stored. The native metadata update route cannot restore an archived document.

Workflow example

Save the input as payload.json:

{
  "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38"
}

CLI:

topolo actions validate app_topolo_docs.documents.archive --data @payload.json --json
topolo actions plan app_topolo_docs.documents.archive --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.documents.archive --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_docs.documents.archive",
    "input": {
      "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true,
  "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38"
}

documentId identifies the successfully archived document; ok acknowledges archiving and removal of the public publication pointer. Version history remains stored. The native metadata update route cannot restore an archived document.

Verify the result

• Call documents.list and confirm the document is no longer active, and that its public URL stops resolving.

Errors and recovery

• HTTP 403 · organization_required: The token carries no organization scope. Re-authenticate against the organization that owns the Docs workspace and retry.

• HTTP 400 · workspace_required: No Docs workspace resolved for the caller. Call workspace.get to see which workspace is bound, then retry in that context.

• HTTP 403 · permission_denied: The credential needs docs:write on the selected Docs workspace.

• HTTP 404 · not_found: No record in this workspace carries that id. List the resource first and use an id from the response.

Docs publishes no unarchive action. The versions survive but the document cannot be restored through the API. Use documents.unpublish when the intent is only to withdraw it from public view.

Evidence boundary

These examples establish local handler behavior and schema validity. They do not establish runtime permission parity, a deployed development/staging result or production completion. Preserve the actual request identifier and perform the verification reads after an authorized live call.