Breadcrumbs

Confluence - Download

Overview

First, you will need your api token, confluence domain, and email.

You will also need the url of the page you want to download.

Variables

Name

Reference

Type

Required

Default

Options

Description

Access Token

CONFLUENCE_ACCESS_TOKEN

Password

-

-

Get yours at: https://id.atlassian.com/manage-profile/security/api-tokens

Email

CONFLUENCE_EMAIL

Alphanumeric

-

-

Your email address that is associated with your Confluence account.

Domain

CONFLUENCE_DOMAIN

Alphanumeric

-

-

Your subdomain is the first part of the Confluence URL. For example, if your URL is https://agencypmg.atlassian.net/wiki/home, your subdomain is "agencypmg".

Page URL

PAGE_URL

Alphanumeric

-

-

The URL of the Confluence page to download.

File Name

FILE_NAME

Alphanumeric

-

-

Name of the file to save the downloaded page as. Use the extension `.html` If not provided, defaults to .html

Folder Name

FOLDER_NAME

Alphanumeric

-

-

Directory to save the file in (default: current directory).

YAML

Below is the YAML template

YAML

source:
  template: Confluence - Download
  inputs:
    CONFLUENCE_ACCESS_TOKEN:
    CONFLUENCE_EMAIL:
    CONFLUENCE_DOMAIN:
    PAGE_URL:
    FILE_NAME:
    FOLDER_NAME:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 2
    - 14
    - 99
    - 103
    - 153