Confluence Cloud v2 Pages API.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the cursor query param; use atlassian.confluence.client/next-cursor
to extract the cursor from a response.
Page/blogpost bodies use storage representation: {:body {:representation "storage" :value "<p>Hello</p>"}}
Confluence Cloud v2 Pages API.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the `cursor` query param; use `atlassian.confluence.client/next-cursor`
to extract the cursor from a response.
Page/blogpost bodies use storage representation:
{:body {:representation "storage" :value "<p>Hello</p>"}}(create-page client body)(create-page client body opts)Create page. POST /wiki/api/v2/pages Body: page creation payload. Include :body {:representation "storage" :value "..."} for content. Optional query opts: embedded, private, root-level.
Create page. POST /wiki/api/v2/pages
Body: page creation payload. Include :body {:representation "storage" :value "..."}
for content. Optional query opts: embedded, private, root-level.(delete-page client id)(delete-page client id opts)Delete page. DELETE /wiki/api/v2/pages/{id} Path params: id (integer) — page ID. Optional query opts: purge, draft.
Delete page. DELETE /wiki/api/v2/pages/{id}
Path params: id (integer) — page ID.
Optional query opts: purge, draft.(get-label-pages client id)(get-label-pages client id opts)Get pages for label. GET /wiki/api/v2/labels/{id}/pages Path params: id (integer) — label ID.
Get pages for label. GET /wiki/api/v2/labels/{id}/pages
Path params: id (integer) — label ID.(get-page-by-id client id)(get-page-by-id client id opts)Get page by id. GET /wiki/api/v2/pages/{id} Path params: id (integer) — page ID. Optional query opts: body-format, get-draft, status, version, include-labels, include-properties, include-operations, include-likes, include-versions, include-version, include-favorited-by-current-user-status, include-webresources, include-collaborators, include-direct-children.
Get page by id. GET /wiki/api/v2/pages/{id}
Path params: id (integer) — page ID.
Optional query opts: body-format, get-draft, status, version,
include-labels, include-properties, include-operations, include-likes,
include-versions, include-version, include-favorited-by-current-user-status,
include-webresources, include-collaborators, include-direct-children.(get-pages client)(get-pages client opts)Get pages. GET /wiki/api/v2/pages All params are optional query opts: id, space-id, sort, status, title, body-format, subtype, cursor, limit.
Get pages. GET /wiki/api/v2/pages All params are optional query opts: id, space-id, sort, status, title, body-format, subtype, cursor, limit.
(get-pages-in-space client id)(get-pages-in-space client id opts)Get pages in space. GET /wiki/api/v2/spaces/{id}/pages Path params: id (integer) — space ID. Optional query opts: depth, sort, status, title, body-format, cursor, limit.
Get pages in space. GET /wiki/api/v2/spaces/{id}/pages
Path params: id (integer) — space ID.
Optional query opts: depth, sort, status, title, body-format, cursor, limit.(update-page client id body)(update-page client id body opts)Update page. PUT /wiki/api/v2/pages/{id} Path params: id (integer) — page ID. Body: updated page payload. Include :version {:number N} (required by API) and :body {:representation "storage" :value "..."}.
Update page. PUT /wiki/api/v2/pages/{id}
Path params: id (integer) — page ID.
Body: updated page payload. Include :version {:number N} (required by API)
and :body {:representation "storage" :value "..."}.(update-page-title client id body)(update-page-title client id body opts)Update page title. PUT /wiki/api/v2/pages/{id}/title Path params: id (integer) — page ID. Body: title update payload, e.g. {:title "New Title" :version {:number N}}.
Update page title. PUT /wiki/api/v2/pages/{id}/title
Path params: id (integer) — page ID.
Body: title update payload, e.g. {:title "New Title" :version {:number N}}.cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |