Skip to main content

Cloud Publishing

Publish reports to the cloud with public access links.

Overview​

Cloud publishing allows reports to be shared publicly via unique access tokens. Published reports are bundled with their dependencies and made available on the cloud platform.

POST /api/reports/{id}/_cloud-publish​

Publish a report to the cloud.

Authentication: Required

Permissions: report:cloudPublish

Path Parameters:

ParameterTypeDescription
idstringReport ID

Request Body:

{
"progress": "progress-monitor-id"
}

Optional Fields:

FieldTypeDescription
progressstringProgress monitor ID for tracking publication

Response:

Returns a cloud access token:

{
"id": "token-uuid",
"type": "report",
"reportId": "team:sales-dashboard",
"token": "abc123def456",
"url": "https://cloud.informer.com/view/abc123def456",
"createdAt": "2024-02-09T10:00:00Z",
"_links": {
"self": { "href": "/api/tokens/token-uuid" }
}
}

Status Code: 200 OK

Behavior:

  1. Create bundle - Packages the report with name and slug
  2. Publish bundle - Uploads to cloud platform with dependencies
  3. Generate token - Creates or retrieves existing public access token
  4. Return link - Provides public URL for sharing

Progress Updates:

The operation sends progress notifications:

  • "Publishing report..."
  • "Making public link..."

Notes:

  • If a token already exists for this report, it is reused
  • Published reports include all necessary data and dependencies
  • Cloud publishing requires appropriate system configuration
  • This is a long-running operation with configurable timeout

POST /api/reports/{id}/_cloud-unpublish​

Unpublish a report from the cloud.

Authentication: Required

Permissions: report:cloudPublish

Path Parameters:

ParameterTypeDescription
idstringReport ID

Response:

204 No Content on success.

Behavior:

  • Removes the report bundle from the cloud platform
  • Revokes public access
  • Existing token becomes invalid

Use Case:

Revoke public access to a previously published report.