API

If you are creating pages with the Confluence API and you want to turn on numbering, you can use the numbering API.

Configure page numbering

PUT https://localhost:1990/confluence/rest/numberedheadings/1.0/page-configuration/:content-id

This endpoint allows to configure page numbering. You can effectively turn numbering on, turn numbering off, or configure formatting, anything that you can configure using the UI.

Path Parameters

Name	Type	Description
content-id	string	ID of the page

Headers

Name	Type	Description
Content-Type	string	application/json

200 Cake successfully retrieved.

{}

The request payload that you should send for this request is as documented in Page properties.

Curl example

curl 'https://localhost:1990/confluence/rest/numberedheadings/1.0/page-configuration/360482' 
-X 'PUT' 
-H 'Content-Type: application/json' 
--data-binary '{"isEnabled":true,"numberFormatField":"decimal","startingNumberField":"3","startingHeadingField":"H1","skipHeadingField":"","customFormatFieldH1":"","customFormatFieldH2":"","customFormatFieldH3":"","customFormatFieldH4":"","customFormatFieldH5":"","customFormatFieldH6":""}' 

Configure space numbering

PUT https://localhost:1990/confluence/rest/numberedheadings/1.0/space-configuration/:spacekey

This endpoint allows you to configure space numbering. You can effectively configure custom formatting through this endpoint.

Path Parameters

Name	Type	Description
spacekey	string	The space key

Headers

Name	Type	Description
Content-Type	string	application/json

200

{}

The request payload that you should send for this request is as documented in Page properties.

Curl example

curl 'http://localhost:1990/confluence/rest/numberedheadings/1.0/space-configuration/ds' \
-X 'PUT' \
-H 'Content-Type: application/json' \
--data-binary '{"isEnabled":true,"numberFormatField":"decimal","startingNumberField":"2","startingHeadingField":"H2","skipHeadingField":"","customFormatFieldH1":"","customFormatFieldH2":"","customFormatFieldH3":"","customFormatFieldH4":"","customFormatFieldH5":"","customFormatFieldH6":""}'