confluence-atlassian（汇合阿特拉斯）

Confluence REST API v2 Skill

Interact with Atlassian Confluence Cloud using the REST API v2. This skill enables reading, creating, updating, and deleting Confluence content including pages, blog posts, attachments, comments, spaces, labels, and more.

Authentication

Basic Auth (Email + API Token)

Required Environment Variables:

CONFLUENCE_EMAIL=your_email@example.com
CONFLUENCE_API_TOKEN=your_api_token
CONFLUENCE_DOMAIN=your_domain  # e.g. "yourcompany" for yourcompany.atlassian.net

Base URL

https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2

Generate API Token

1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Label it (e.g., "nanobot")
4. Copy the token

curl Authentication

--user "$CONFLUENCE_EMAIL:$CONFLUENCE_API_TOKEN"

curl Authentication Header:

-H "Authorization: Basic $(echo -n '$CONFLUENCE_EMAIL:$CONFLUENCE_API_TOKEN' | base64)"

Generate Base64 Auth String

# Linux/Mac
echo -n "$CONFLUENCE_EMAIL:$CONFLUENCE_API_TOKEN" | base64

# Windows PowerShell
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("$CONFLUENCE_EMAIL:$CONFLUENCE_API_TOKEN"))

Rate Limiting

• If you encounter HTTP 429 (Too Many Requests), wait 5-10 seconds and retry automatically
• Maximum 3 retries with exponential backoff

Common Headers

-H "Accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Basic <base64_encoded_auth>"

API Endpoints Reference

Total: 100+ API Endpoints across 29 API Groups

1. Admin Key (3 endpoints)

Get Admin Key:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/admin-key" \
  -H "Authorization: Basic <base64_auth>"

Enable Admin Key (10 min default):

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/admin-key" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{"durationInMinutes": 10}'

2. Attachment (8 endpoints)

Get All Attachments:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/attachments?limit=25" \
  -H "Authorization: Basic <base64_auth>"

Get Attachment by ID:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/attachments/att123456" \
  -H "Authorization: Basic <base64_auth>"

Delete Attachment (move to trash):

curl -X DELETE "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/attachments/att123456" \
  -H "Authorization: Basic <base64_auth>"

Purge (permanently delete) trashed attachment:

curl -X DELETE "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/attachments/att123456?purge=true" \
  -H "Authorization: Basic <base64_auth>"

3. Blog Post (15 endpoints)

Get All Blog Posts:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/blogposts?limit=25&space-id=123" \
  -H "Authorization: Basic <base64_auth>"

Create Blog Post:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/blogposts" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "spaceId": "SPACE_KEY",
    "title": "My Blog Post",
    "body": {
      "representation": "storage",
      "value": "<p>Blog post content here</p>"
    }
  }'

Get Blog Post with Body:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/blogposts/123?body-format=storage" \
  -H "Authorization: Basic <base64_auth>"

4. Comment (12 endpoints)

Create Footer Comment on Page:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/footer-comments" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "pageId": "123456",
    "body": {
      "representation": "storage",
      "value": "<p>Comment content</p>"
    }
  }'

Create Inline Comment:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/inline-comments" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "pageId": "123456",
    "body": {
      "representation": "storage",
      "value": "<p>Inline comment</p>"
    },
    "inlineCommentProperties": {
      "textSelection": "selected text",
      "textSelectionMatchCount": 1,
      "textSelectionMatchIndex": 0
    }
  }'

Resolve Inline Comment:

curl -X PUT "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/inline-comments/123" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "version": {"number": 2},
    "resolved": true
  }'

5. Content Properties (40 endpoints)

For: Attachments, Blog Posts, Pages, Custom Content, Whiteboards, Databases, Folders, Comments, Smart Links

Get Page Properties:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/properties" \
  -H "Authorization: Basic <base64_auth>"

Create Page Property:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/properties" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "custom-key",
    "value": {"nested": "value"}
  }'

Update Page Property:

curl -X PUT "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/properties/789" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "custom-key",
    "value": {"updated": "value"},
    "version": {"number": 2}
  }'

6. Label (14 endpoints)

Get Page Labels:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/labels" \
  -H "Authorization: Basic <base64_auth>"

7. Page (14 endpoints)

Get All Pages in Space:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages?space-id=123&limit=50" \
  -H "Authorization: Basic <base64_auth>"

Get Page with Body:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456?body-format=storage" \
  -H "Authorization: Basic <base64_auth>"

Create Page:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "spaceId": "SPACE_KEY",
    "title": "My New Page",
    "parentId": "123456",
    "body": {
      "representation": "storage",
      "value": "<p>Page content in storage format</p>"
    }
  }'

Update Page:

curl -X PUT "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "123456",
    "status": "current",
    "title": "Updated Page Title",
    "body": {
      "representation": "storage",
      "value": "<p>Updated content</p>"
    },
    "version": {
      "number": 5,
      "message": "Updated page content"
    }
  }'

Delete Page (move to trash):

curl -X DELETE "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456" \
  -H "Authorization: Basic <base64_auth>"

8. Space (22 endpoints)

Get All Spaces:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/spaces?limit=50" \
  -H "Authorization: Basic <base64_auth>"

Get Space by Key:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/spaces?keys=SPACE_KEY" \
  -H "Authorization: Basic <base64_auth>"

Create Space:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/spaces" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New Space",
    "key": "MYSpace",
    "description": {
      "plain": {
        "value": "Space description"
      }
    }
  }'

9. User (9 endpoints)

Get Current User:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/users/me" \
  -H "Authorization: Basic <base64_auth>"

Get User by ID:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/users/123456" \
  -H "Authorization: Basic <base64_auth>"

Bulk Get Users:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/users/bulk?ids=123,456" \
  -H "Authorization: Basic <base64_auth>"

10. Version History (8 endpoints)

Get Page Versions:

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/versions?limit=10" \
  -H "Authorization: Basic <base64_auth>"

Restore Page Version:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/versions/restore" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{"newVersion": {"message": "Restoring previous version"}}'

11. Whiteboard (7 endpoints)

Create Whiteboard:

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/whiteboards" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "spaceId": "123456",
    "title": "My Whiteboard"
  }'

Pagination

The V2 API uses cursor-based pagination. Responses include a _links.next URL when more results are available.

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages?space-id=123456&limit=100" \
  -H "Authorization: Basic <base64_auth>"

Response:

{
  "results": [...],
  "_links": {
    "next": "/wiki/api/v2/pages?cursor=abc123",
    "base": "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki"
  }
}

Search

Search Pages by Title

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages?title=My%20Page&space-id=123456" \
  -H "Authorization: Basic <base64_auth>"

Get Page with All Details

curl -X GET "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456?include-labels=true&include-properties=true&include-versions=true&body-format=storage" \
  -H "Authorization: Basic <base64_auth>"

Update Page Title

curl -X PUT "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/title" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{"value": "New Page Title"}'

Redact Page Content (remove sensitive content)

curl -X POST "https://$CONFLUENCE_DOMAIN.atlassian.net/wiki/api/v2/pages/123456/redact" \
  -H "Authorization: Basic <base64_auth>" \
  -H "Content-Type: application/json" \
  -d '{
    "version": {"number": 3},
    "body": {
      "representation": "storage",
      "value": "<p>Redacted content</p>"
    }
  }'

Error Handling

Notes

• Confluence Storage Format: Content uses XML-like storage format. Example: <p>Paragraph</p>, <h1>Heading</h1>, <ul><li>Item</li></ul>
• Version Numbers: When updating pages, you must increment the version number
• DELETE Returns 204: DELETE operations return 204 No Content
• IDs are Strings: All IDs are passed as strings
• Cursor Pagination: Use the cursor from _links.next for pagination