Type to search.

Confluence Cloud connector

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview 9.4+

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview since 9.4

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The Confluence Cloud connector communicates with the Confluence Cloud REST API v2 to list and retrieve spaces and pages. It uses Basic authentication (email and API token) and connects to your Atlassian site by subdomain.

You can use this connector in Agent Builder and Workflows.

You can create connectors in Stack Management > Connectors.

Confluence Cloud connectors have the following configuration properties:

Account email
Your Atlassian account email address used for Basic authentication.
Subdomain
Your Atlassian subdomain (for example, your-domain for https://your-domain.atlassian.net).
API token
Your Atlassian API token for authentication. Refer to Get API credentials for instructions.

You can test connectors when you create or edit the connector in Kibana.

The Confluence Cloud connector has the following actions:

List pages

List Confluence pages with optional filters and cursor-based pagination.

  • limit (optional): Maximum number of pages to return, from 1 to 250.
  • cursor (optional): Pagination cursor from a previous response.
  • spaceId (optional): Numeric space ID or list of space IDs to filter by.
  • title (optional): Filter pages by title (partial match).
  • status (optional): Page status filter (current, archived, deleted, or trashed).
  • bodyFormat (optional): Format for page body in the response (atlas_doc_format or storage).
Get page

Retrieve full details of a single Confluence page by ID.

  • id (required): The numeric ID of the page to retrieve.
  • bodyFormat (optional): Format for page body in the response.
List spaces

List Confluence spaces with optional filters and cursor-based pagination.

  • limit (optional): Maximum number of spaces to return, from 1 to 250.
  • cursor (optional): Pagination cursor from a previous response.
  • ids (optional): Numeric space ID or list of space IDs to filter by.
  • keys (optional): Space key or list of space keys to filter by (for example, DEMO, TEAM).
  • type (optional): Space type filter (for example, global, personal).
  • status (optional): Space status filter (current, archived, or trashed).
Get space

Retrieve full details of a single Confluence space by ID.

  • id (required): The ID of the space to retrieve.

Use the Action configuration settings to customize connector networking, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

To use the Confluence Cloud connector, you need an Atlassian API token:

  1. Log in to your Atlassian account.
  2. Go to Security > API tokens (or open API token management directly).
  3. Select Create API token.
  4. Enter a label (for example, Kibana Confluence connector) and select Create.
  5. Copy the token and store it securely. Enter this value as the API token when configuring the connector in Kibana. The email address associated with your Atlassian account is used as the username for Basic authentication.