Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 3.35 KB

index.md

File metadata and controls

92 lines (69 loc) · 3.35 KB
organization category icon_url brand_color display_name short_name description og_description og_image
ellisvalentiner
software development
/images/plugins/ellisvalentiner/confluence.svg
#2684FF
Confluence
confluence
Steampipe plugin for querying pages, spaces, and more from Confluence.
Query Confluence with SQL! Open source CLI. No DB required.
/images/plugins/ellisvalentiner/confluence-social-graphic.png

Confluence + Steampipe

Confluence is a collaboration wiki tool used to help teams to collaborate and share knowledge efficiently.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
  id,
  title,
  space_key,
  status,
  type,
  version_number
from
  confluence_content;
+--------+------------------------------+-----------+---------+------+----------------+
| id     | title                        | space_key | status  | type | version_number |
+--------+------------------------------+-----------+---------+------+----------------+
| 163576 | Documentation                | DOC       | current | page | 5              |
| 110222 | HTTP Status Codes            | DOC       | current | page | 3              |
| 336504 | Confluence Getting started   | DOC       | current | page | 2              |
| 916343 | Staff Directory              | DOC       | current | page | 2              |
| 196895 | Product Requirements         | DOC       | current | page | 2              |
+--------+------------------------------+-----------+---------+------+----------------+

Documentation

Get started

Install

Download and install the latest Confluence plugin:

steampipe plugin install ellisvalentiner/confluence

Credentials

Item Description
Credentials Confluence requires an API token, site base url and username for all requests.

Configuration

Installing the latest Confluence plugin will create a config file (~/.steampipe/config/confluence.spc) with a single connection named confluence:

connection "confluence" {
    plugin    = "ellisvalentiner/confluence"

    # Base URI of your Confluence Cloud instance
    base_url = "https://your-domain.atlassian.net/"

    # The user name to access the Confluence cloud instance
    # username = "name@company.domain"

    # Access Token for the API
    # See https://id.atlassian.com/manage/api-tokens
    # token = ""
}
  • base_url - The site url of your Atlassian subscription.
  • username - Email address of agent user who have permission to access the API.
  • token - API token for user's Atlassian account.

Get involved