API

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 This endpoint allows to configure page numbering. You can effectively turn numbering on or off, configure formatting, or anything that you can configure using the UI. Parameters Path content-id string ID of the page Header Content-Type string application/json Responses 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 page numbering This endpoint allows you to configure space numbering. You can effectively configure custom formatting through this endpoint. Parameters Path spacekey string The space key Header Content-Type string application/json Responses 200 Cake successfully retrieved. {}

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":""}'

 

Need support? Create a request with our support team.

Copyright © 2005 - 2026 Appfire | All rights reserved.