Topolo Docs Topolo Platform
Open workspace

Export workspace documentation

Export spaces, documents, versions, and publication metadata for the selected workspace.

Outcome

Export spaces, documents, versions, and publication metadata for the selected workspace.

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:export; the active credential and resource binding must authorize the call.

Discover the target


topolo actions get app_topolo_docs.workspace.export --detail --json
topolo resources topolo-docs --json
topolo workspaces list topolo-docs --json

Input fields

Use {} as the input.

Interpret the response

export is a schemaVersion 1 workspace snapshot, including archived records, immutable versions, publications and operations. It contains private content and audit metadata; handle it within the organization. This action does not implement restore or certify an external backup.

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:


{}

CLI:


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

MCP tool and arguments:


{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.workspace.export",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:


{
  "export": {
    "schemaVersion": 1,
    "exportedAt": "2026-10-06T11:52:57.238Z",
    "organizationId": "org_fixture",
    "workspaceId": "ws_fixture",
    "spaces": [
      {
        "id": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "slug": "reference-minimal",
        "title": "minimal integration reference",
        "description": "Reference for rotating integration tokens.",
        "visibility": "public",
        "defaultLocale": "en",
        "brand": {},
        "status": "active",
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.487Z",
        "updatedAt": "2026-10-06T11:52:54.606Z"
      }
    ],
    "sections": [
      {
        "id": "docsec_942b8988-fefa-47b5-8fa6-98654ec14f3d",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "slug": "integration-guides",
        "title": "Token rotation",
        "position": 0,
        "createdAt": "2026-10-06T11:52:54.656Z",
        "updatedAt": "2026-10-06T11:52:54.752Z"
      }
    ],
    "documents": [
      {
        "id": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "sectionId": "docsec_942b8988-fefa-47b5-8fa6-98654ec14f3d",
        "sectionPosition": 0,
        "parentId": null,
        "slug": "rotate-token",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "status": "published",
        "sourceKind": "native",
        "ownerAppId": null,
        "currentVersionId": "docver_1d7bd567-0f07-4df2-be19-b9301abc2c30",
        "publishedVersionId": "docver_1d7bd567-0f07-4df2-be19-b9301abc2c30",
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.793Z",
        "updatedAt": "2026-10-06T11:52:55.269Z",
        "publishedAt": "2026-10-06T11:52:55.269Z"
      }
    ],
    "versions": [
      {
        "id": "docver_adf920a9-b63b-4e1b-9947-05f763d735cc",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "1499e80576ef14317aee62135063b901e7a9cb64c02082bac0fcd159886348ba",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.823Z"
      },
      {
        "id": "docver_1d7bd567-0f07-4df2-be19-b9301abc2c30",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "f14fd31c10cbbf734ad4677c8c68f7036d2f3625815ed61465ff8375acd5e0b6",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:55.113Z"
      }
    ],
    "publications": [
      {
        "id": "docpub_78d45660-d29f-4a87-9025-85f9ea74b859",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "releaseNumber": 1,
        "status": "published",
        "manifest": {
          "version": 1,
          "publicationId": "docpub_78d45660-d29f-4a87-9025-85f9ea74b859",
          "releaseNumber": 1,
          "space": {
            "id": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
            "slug": "reference-minimal",
            "title": "minimal integration reference",
            "defaultLocale": "en"
          },
          "publishedAt": "2026-10-06T11:52:55.269Z"
        },
        "createdByUserId": "usr_fixture",
        "publishedAt": "2026-10-06T11:52:55.269Z"
      }
    ],
    "operations": {
      "workflowEvents": [
        {
          "id": "docsevt:catalog-drift-detected:drift-minimal",
          "event_type": "docs.catalog.drift_detected",
          "actor_user_id": "usr_fixture",
          "object_id": "drift-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-minimal\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:57.091Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "created_at": "2026-10-06T11:52:57.091Z"
        },
        {
          "id": "docsevt:link-check-failed:link-minimal",
          "event_type": "docs.link_check.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "link-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-minimal\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:57.118Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "created_at": "2026-10-06T11:52:57.118Z"
        },
        {
          "id": "docsevt:publish-completed:publish-minimal",
          "event_type": "docs.publish.completed",
          "actor_user_id": "usr_fixture",
          "object_id": "publish-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-minimal\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-minimal/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:57.143Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "created_at": "2026-10-06T11:52:57.143Z"
        },
        {
          "id": "docsevt:publish-failed:failed-minimal",
          "event_type": "docs.publish.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "failed-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-minimal\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:57.169Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "created_at": "2026-10-06T11:52:57.169Z"
        }
      ],
      "notificationOutbox": [
        {
          "id": "docsout:catalog-drift-detected:drift-minimal",
          "event_type": "docs.catalog.drift_detected",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:catalog-drift-detected:drift-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-minimal\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:57.091Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.091Z",
          "updated_at": "2026-10-06T11:52:57.091Z",
          "sent_at": null
        },
        {
          "id": "docsout:link-check-failed:link-minimal",
          "event_type": "docs.link_check.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:link-check-failed:link-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-minimal\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:57.118Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.118Z",
          "updated_at": "2026-10-06T11:52:57.118Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-completed:publish-minimal",
          "event_type": "docs.publish.completed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-completed:publish-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-minimal\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-minimal/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:57.143Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.143Z",
          "updated_at": "2026-10-06T11:52:57.143Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-failed:failed-minimal",
          "event_type": "docs.publish.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-failed:failed-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-minimal\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:57.169Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.169Z",
          "updated_at": "2026-10-06T11:52:57.169Z",
          "sent_at": null
        }
      ]
    }
  }
}

export is a schemaVersion 1 workspace snapshot, including archived records, immutable versions, publications and operations. It contains private content and audit metadata; handle it within the organization. This action does not implement restore or certify an external backup.

Workflow example

Save the input as payload.json:


{}

CLI:


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

MCP tool and arguments:


{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.workspace.export",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:


{
  "export": {
    "schemaVersion": 1,
    "exportedAt": "2026-10-06T11:52:59.944Z",
    "organizationId": "org_fixture",
    "workspaceId": "ws_fixture",
    "spaces": [
      {
        "id": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "slug": "reference-minimal",
        "title": "minimal integration reference",
        "description": "Reference for rotating integration tokens.",
        "visibility": "public",
        "defaultLocale": "en",
        "brand": {},
        "status": "archived",
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.487Z",
        "updatedAt": "2026-10-06T11:52:57.412Z"
      },
      {
        "id": "docspace_8628428f-b6e6-468b-b34a-f930d841accb",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "slug": "reference-workflow",
        "title": "workflow integration reference",
        "description": "Reference for rotating integration tokens.",
        "visibility": "public",
        "defaultLocale": "en",
        "brand": {},
        "status": "active",
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:57.498Z",
        "updatedAt": "2026-10-06T11:52:57.581Z"
      }
    ],
    "sections": [
      {
        "id": "docsec_74eb04f4-a413-4a1d-8024-c3a020d749b1",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_8628428f-b6e6-468b-b34a-f930d841accb",
        "slug": "integration-guides",
        "title": "Token rotation",
        "position": 0,
        "createdAt": "2026-10-06T11:52:57.625Z",
        "updatedAt": "2026-10-06T11:52:57.707Z"
      }
    ],
    "documents": [
      {
        "id": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "sectionId": null,
        "sectionPosition": 0,
        "parentId": null,
        "slug": "rotate-token",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "status": "archived",
        "sourceKind": "native",
        "ownerAppId": null,
        "currentVersionId": "docver_1d7bd567-0f07-4df2-be19-b9301abc2c30",
        "publishedVersionId": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.793Z",
        "updatedAt": "2026-10-06T11:52:57.402Z",
        "publishedAt": null
      },
      {
        "id": "doc_f40cddd1-bac6-41ca-9f3a-6d85580ae128",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_8628428f-b6e6-468b-b34a-f930d841accb",
        "sectionId": "docsec_74eb04f4-a413-4a1d-8024-c3a020d749b1",
        "sectionPosition": 0,
        "parentId": null,
        "slug": "rotate-token",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "status": "published",
        "sourceKind": "native",
        "ownerAppId": null,
        "currentVersionId": "docver_0c80d536-c3b6-460f-8740-c63b3d3c2016",
        "publishedVersionId": "docver_0c80d536-c3b6-460f-8740-c63b3d3c2016",
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:57.741Z",
        "updatedAt": "2026-10-06T11:52:58.114Z",
        "publishedAt": "2026-10-06T11:52:58.114Z"
      }
    ],
    "versions": [
      {
        "id": "docver_adf920a9-b63b-4e1b-9947-05f763d735cc",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "1499e80576ef14317aee62135063b901e7a9cb64c02082bac0fcd159886348ba",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:54.823Z"
      },
      {
        "id": "docver_1d7bd567-0f07-4df2-be19-b9301abc2c30",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f6eed025-c509-472f-9d70-a546676087b7",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "f14fd31c10cbbf734ad4677c8c68f7036d2f3625815ed61465ff8375acd5e0b6",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:55.113Z"
      },
      {
        "id": "docver_4b469c37-a84d-479d-ac64-7c13a2214bf5",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f40cddd1-bac6-41ca-9f3a-6d85580ae128",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "1499e80576ef14317aee62135063b901e7a9cb64c02082bac0fcd159886348ba",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:57.767Z"
      },
      {
        "id": "docver_0c80d536-c3b6-460f-8740-c63b3d3c2016",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "documentId": "doc_f40cddd1-bac6-41ca-9f3a-6d85580ae128",
        "locale": "en",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token.",
        "bodyMarkdown": "# Rotate a token\n\nOpen credential settings, replace the token and verify a read.",
        "agentGuidance": null,
        "contentHash": "f14fd31c10cbbf734ad4677c8c68f7036d2f3625815ed61465ff8375acd5e0b6",
        "sourceRevision": null,
        "sourcePath": null,
        "createdByUserId": "usr_fixture",
        "createdAt": "2026-10-06T11:52:57.992Z"
      }
    ],
    "publications": [
      {
        "id": "docpub_78d45660-d29f-4a87-9025-85f9ea74b859",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
        "releaseNumber": 1,
        "status": "published",
        "manifest": {
          "version": 1,
          "publicationId": "docpub_78d45660-d29f-4a87-9025-85f9ea74b859",
          "releaseNumber": 1,
          "space": {
            "id": "docspace_4940cbe5-be27-474c-bc80-0f3df6094965",
            "slug": "reference-minimal",
            "title": "minimal integration reference",
            "defaultLocale": "en"
          },
          "publishedAt": "2026-10-06T11:52:55.269Z"
        },
        "createdByUserId": "usr_fixture",
        "publishedAt": "2026-10-06T11:52:55.269Z"
      },
      {
        "id": "docpub_e27d9ed2-2f54-41ed-ae98-d245c147dc72",
        "organizationId": "org_fixture",
        "workspaceId": "ws_fixture",
        "spaceId": "docspace_8628428f-b6e6-468b-b34a-f930d841accb",
        "releaseNumber": 1,
        "status": "published",
        "manifest": {
          "version": 1,
          "publicationId": "docpub_e27d9ed2-2f54-41ed-ae98-d245c147dc72",
          "releaseNumber": 1,
          "space": {
            "id": "docspace_8628428f-b6e6-468b-b34a-f930d841accb",
            "slug": "reference-workflow",
            "title": "workflow integration reference",
            "defaultLocale": "en"
          },
          "publishedAt": "2026-10-06T11:52:58.114Z"
        },
        "createdByUserId": "usr_fixture",
        "publishedAt": "2026-10-06T11:52:58.114Z"
      }
    ],
    "operations": {
      "workflowEvents": [
        {
          "id": "docsevt:catalog-drift-detected:drift-minimal",
          "event_type": "docs.catalog.drift_detected",
          "actor_user_id": "usr_fixture",
          "object_id": "drift-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-minimal\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:57.091Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "created_at": "2026-10-06T11:52:57.091Z"
        },
        {
          "id": "docsevt:link-check-failed:link-minimal",
          "event_type": "docs.link_check.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "link-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-minimal\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:57.118Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "created_at": "2026-10-06T11:52:57.118Z"
        },
        {
          "id": "docsevt:publish-completed:publish-minimal",
          "event_type": "docs.publish.completed",
          "actor_user_id": "usr_fixture",
          "object_id": "publish-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-minimal\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-minimal/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:57.143Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "created_at": "2026-10-06T11:52:57.143Z"
        },
        {
          "id": "docsevt:publish-failed:failed-minimal",
          "event_type": "docs.publish.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "failed-minimal",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-minimal\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:57.169Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "created_at": "2026-10-06T11:52:57.169Z"
        },
        {
          "id": "docsevt:catalog-drift-detected:drift-workflow",
          "event_type": "docs.catalog.drift_detected",
          "actor_user_id": "usr_fixture",
          "object_id": "drift-workflow",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-workflow\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:59.812Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "created_at": "2026-10-06T11:52:59.812Z"
        },
        {
          "id": "docsevt:link-check-failed:link-workflow",
          "event_type": "docs.link_check.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "link-workflow",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-workflow\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:59.833Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "created_at": "2026-10-06T11:52:59.833Z"
        },
        {
          "id": "docsevt:publish-completed:publish-workflow",
          "event_type": "docs.publish.completed",
          "actor_user_id": "usr_fixture",
          "object_id": "publish-workflow",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-workflow\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-workflow/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:59.853Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "created_at": "2026-10-06T11:52:59.853Z"
        },
        {
          "id": "docsevt:publish-failed:failed-workflow",
          "event_type": "docs.publish.failed",
          "actor_user_id": "usr_fixture",
          "object_id": "failed-workflow",
          "payload_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-workflow\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:59.874Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "created_at": "2026-10-06T11:52:59.874Z"
        }
      ],
      "notificationOutbox": [
        {
          "id": "docsout:catalog-drift-detected:drift-minimal",
          "event_type": "docs.catalog.drift_detected",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:catalog-drift-detected:drift-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-minimal\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:57.091Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.091Z",
          "updated_at": "2026-10-06T11:52:57.091Z",
          "sent_at": null
        },
        {
          "id": "docsout:link-check-failed:link-minimal",
          "event_type": "docs.link_check.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:link-check-failed:link-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-minimal\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:57.118Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.118Z",
          "updated_at": "2026-10-06T11:52:57.118Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-completed:publish-minimal",
          "event_type": "docs.publish.completed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-completed:publish-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-minimal\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-minimal/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:57.143Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.143Z",
          "updated_at": "2026-10-06T11:52:57.143Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-failed:failed-minimal",
          "event_type": "docs.publish.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-failed:failed-minimal",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-minimal\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:57.169Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:57.169Z",
          "updated_at": "2026-10-06T11:52:57.169Z",
          "sent_at": null
        },
        {
          "id": "docsout:catalog-drift-detected:drift-workflow",
          "event_type": "docs.catalog.drift_detected",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:catalog-drift-detected:drift-workflow",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.title\",\"text\":{\"en\":\"Documentation catalog drift detected\",\"ar\":\"Documentation catalog drift detected\",\"es\":\"Documentation catalog drift detected\",\"fr\":\"Écart détecté dans le catalogue documentaire\",\"de\":\"Documentation catalog drift detected\",\"pt-BR\":\"Documentation catalog drift detected\",\"ja\":\"Documentation catalog drift detected\",\"hi\":\"Documentation catalog drift detected\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.catalogDrift.body\",\"values\":{\"source\":\"local-fixture\"},\"text\":{\"en\":\"local-fixture no longer matches its published documentation catalog.\",\"ar\":\"local-fixture no longer matches its published documentation catalog.\",\"es\":\"local-fixture no longer matches its published documentation catalog.\",\"fr\":\"local-fixture no longer matches its published documentation catalog.\",\"de\":\"local-fixture no longer matches its published documentation catalog.\",\"pt-BR\":\"local-fixture no longer matches its published documentation catalog.\",\"ja\":\"local-fixture no longer matches its published documentation catalog.\",\"hi\":\"local-fixture no longer matches its published documentation catalog.\"}}},\"object_id\":\"drift-workflow\",\"source\":\"local-fixture\",\"expected_digest\":\"expected\",\"actual_digest\":\"actual\",\"occurred_at\":\"2026-10-06T11:52:59.812Z\",\"title\":\"Documentation catalog drift detected\",\"body\":\"local-fixture no longer matches its published documentation catalog.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:59.812Z",
          "updated_at": "2026-10-06T11:52:59.812Z",
          "sent_at": null
        },
        {
          "id": "docsout:link-check-failed:link-workflow",
          "event_type": "docs.link_check.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:link-check-failed:link-workflow",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.title\",\"text\":{\"en\":\"Documentation link check failed\",\"ar\":\"Documentation link check failed\",\"es\":\"Documentation link check failed\",\"fr\":\"Échec de la vérification du lien documentaire\",\"de\":\"Documentation link check failed\",\"pt-BR\":\"Documentation link check failed\",\"ja\":\"Documentation link check failed\",\"hi\":\"Documentation link check failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.linkCheckFailed.body\",\"values\":{\"checkedUrl\":\"https://docs.example.com/missing\"},\"text\":{\"en\":\"https://docs.example.com/missing failed documentation link validation.\",\"ar\":\"https://docs.example.com/missing failed documentation link validation.\",\"es\":\"https://docs.example.com/missing failed documentation link validation.\",\"fr\":\"https://docs.example.com/missing failed documentation link validation.\",\"de\":\"https://docs.example.com/missing failed documentation link validation.\",\"pt-BR\":\"https://docs.example.com/missing failed documentation link validation.\",\"ja\":\"https://docs.example.com/missing failed documentation link validation.\",\"hi\":\"https://docs.example.com/missing failed documentation link validation.\"}}},\"object_id\":\"link-workflow\",\"checked_url\":\"https://docs.example.com/missing\",\"status_code\":404,\"reason\":\"Local fixture link check failure.\",\"occurred_at\":\"2026-10-06T11:52:59.833Z\",\"title\":\"Documentation link check failed\",\"body\":\"https://docs.example.com/missing failed documentation link validation.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:59.833Z",
          "updated_at": "2026-10-06T11:52:59.833Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-completed:publish-workflow",
          "event_type": "docs.publish.completed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-completed:publish-workflow",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.title\",\"text\":{\"en\":\"Documentation publish completed\",\"ar\":\"Documentation publish completed\",\"es\":\"Documentation publish completed\",\"fr\":\"Publication de la documentation terminée\",\"de\":\"Documentation publish completed\",\"pt-BR\":\"Documentation publish completed\",\"ja\":\"Documentation publish completed\",\"hi\":\"Documentation publish completed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishCompleted.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"development\"},\"text\":{\"en\":\"local-fixture was published to development.\",\"ar\":\"local-fixture was published to development.\",\"es\":\"local-fixture was published to development.\",\"fr\":\"local-fixture was published to development.\",\"de\":\"local-fixture was published to development.\",\"pt-BR\":\"local-fixture was published to development.\",\"ja\":\"local-fixture was published to development.\",\"hi\":\"local-fixture was published to development.\"}}},\"object_id\":\"publish-workflow\",\"revision\":\"local-fixture\",\"environment\":\"development\",\"published_url\":\"https://docs.test/s/reference-workflow/rotate-token\",\"occurred_at\":\"2026-10-06T11:52:59.853Z\",\"title\":\"Documentation publish completed\",\"body\":\"local-fixture was published to development.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:59.853Z",
          "updated_at": "2026-10-06T11:52:59.853Z",
          "sent_at": null
        },
        {
          "id": "docsout:publish-failed:failed-workflow",
          "event_type": "docs.publish.failed",
          "user_id": "usr_fixture",
          "idempotency_key": "docs:publish-failed:failed-workflow",
          "data_json": "{\"localized\":{\"title\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.title\",\"text\":{\"en\":\"Documentation publish failed\",\"ar\":\"Documentation publish failed\",\"es\":\"Documentation publish failed\",\"fr\":\"Échec de la publication de la documentation\",\"de\":\"Documentation publish failed\",\"pt-BR\":\"Documentation publish failed\",\"ja\":\"Documentation publish failed\",\"hi\":\"Documentation publish failed\"}},\"body\":{\"appId\":\"app_topolo_docs\",\"releaseId\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\"key\":\"docs.notifications.publishFailed.body\",\"values\":{\"revision\":\"local-fixture\",\"environment\":\"staging\"},\"text\":{\"en\":\"local-fixture failed to publish to staging.\",\"ar\":\"local-fixture failed to publish to staging.\",\"es\":\"local-fixture failed to publish to staging.\",\"fr\":\"local-fixture failed to publish to staging.\",\"de\":\"local-fixture failed to publish to staging.\",\"pt-BR\":\"local-fixture failed to publish to staging.\",\"ja\":\"local-fixture failed to publish to staging.\",\"hi\":\"local-fixture failed to publish to staging.\"}}},\"object_id\":\"failed-workflow\",\"revision\":\"local-fixture\",\"environment\":\"staging\",\"reason\":\"Local fixture proof only; no deployment occurred.\",\"occurred_at\":\"2026-10-06T11:52:59.874Z\",\"title\":\"Documentation publish failed\",\"body\":\"local-fixture failed to publish to staging.\"}",
          "status": "pending",
          "attempts": 0,
          "last_error": null,
          "created_at": "2026-10-06T11:52:59.874Z",
          "updated_at": "2026-10-06T11:52:59.874Z",
          "sent_at": null
        }
      ]
    }
  }
}

export is a schemaVersion 1 workspace snapshot, including archived records, immutable versions, publications and operations. It contains private content and audit metadata; handle it within the organization. This action does not implement restore or certify an external backup.

Verify the result

  • Require export.schemaVersion to equal 1 and export.workspaceId to match the selected workspace. Inspect the full private snapshot before relying on it; the action provides no restore operation.

Errors and recovery

  • HTTP 401 · authentication_required: Authenticate again or provide a valid Topolo API key.

  • HTTP 403 · permission_denied: Grant the credential permission docs:export and the required resource binding.

  • HTTP 429 · rate_limited: Wait for Retry-After when present, then retry without parallel duplicate calls.

  • HTTP 422 · invalid_input: Correct the payload using inputSchema, then validate before retrying.

  • HTTP 503 · dependency_unavailable: Retry the action. If it continues, inspect the structured error details using the request ID.

This action does not change service state.

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.