The Confluence API provides comprehensive access to pages, spaces, users, comments, and other Confluence resources. Use the /confluence/{target} endpoint to proxy requests to the Confluence REST API.

Operations

GET/confluence/{target}PUT/confluence/{target}POST/confluence/{target}DEL/confluence/{target}OPT/confluence/{target}HEAD/confluence/{target}PATCH/confluence/{target}

GET

Proxy GET request to Confluence API

Proxies requests to the Confluence Cloud REST API v2. The target parameter specifies the Confluence API endpoint.

API Documentation: Confluence Cloud REST API v2

Examples:

/confluence/api/v2/pages/123 - Get page details
/confluence/api/v2/spaces - List spaces
/confluence/api/v2/users/me - Get current user info
/confluence/api/v2/pages/123/comments - Get page comments

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Confluence API

application/json

object

GET/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PUT

Proxy PUT request to Confluence API

Proxies PUT requests to the Confluence Cloud REST API v2. The target parameter specifies the Confluence API endpoint.

API Documentation: Confluence Cloud REST API v2

Examples:

/confluence/api/v2/pages/123 - Update page
/confluence/api/v2/blogs/123 - Update blog post

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Confluence API

application/json

object

PUT/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST

Proxy POST request to Confluence API

Proxies POST requests to the Confluence Cloud REST API v2. The target parameter specifies the Confluence API endpoint.

API Documentation: Confluence Cloud REST API v2

Examples:

/confluence/api/v2/pages - Create new page
/confluence/api/v2/pages/123/comments - Add comment to page
/confluence/api/v2/blogs - Create new blog post

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Confluence API

application/json

object

POST/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

DEL

Proxy DELETE request to Confluence API

Proxies DELETE requests to the Confluence Cloud REST API v2. The target parameter specifies the Confluence API endpoint.

API Documentation: Confluence Cloud REST API v2

Examples:

/confluence/api/v2/pages/123 - Delete page
/confluence/api/v2/pages/123/comments/456 - Delete comment

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Confluence API

application/json

object

DEL/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request DELETE \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

OPT

Proxy OPTIONS request to Confluence API

Proxies OPTIONS requests to the Confluence Cloud REST API v2. Used for CORS preflight requests and method discovery.

API Documentation: Confluence Cloud REST API v2

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Confluence API

application/json

object

OPT/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request OPTIONS \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

HEAD

Proxy HEAD request to Confluence API

Proxies HEAD requests to the Confluence Cloud REST API v2. Returns headers without response body, useful for checking resource existence.

API Documentation: Confluence Cloud REST API v2

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied to Confluence API

application/json

object

HEAD/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request HEAD \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PATCH

Proxy PATCH request to Confluence API

Proxies PATCH requests to the Confluence Cloud REST API v2. The target parameter specifies the Confluence API endpoint.

API Documentation: Confluence Cloud REST API v2

Examples:

/confluence/api/v2/pages/123 - Partially update page

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied to Confluence API

application/json

object

PATCH/confluence/{target}

curl

Node.js

Java

Python

PHP

curl --request PATCH \
  --url '{FORGE_EGRESS_PROXY_URL}/confluence/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'