Skip to end of banner
Go to start of banner

Pages for Bitbucket Server REST API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »


Get status of Pages Support for specified repository and branch/tag

GET /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled
 Example Request

curl -u username:password -H "Content-Type:application/json" http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled?refId=refs/heads/master

 Example Response
{"repositoryId":1,"refId":"refs/heads/master","isEnabled":true}

Enable Pages support for specified repository and branch/tag

PUT /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled
 Example Request

curl -u username:password -H "Content-Type:application/json" -X PUT http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled?refId=refs/heads/master

 Example Response
{"repositoryId":1,"refId":"refs/heads/master","isEnabled":true}

Disable Pages support for specified repository and branch/tag

DELETE /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled
 Example Request

curl -u username:password -H "Content-Type:application/json" -X DELETE http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled?refId=refs/heads/master

 Example Response
{"repositoryId":1,"refId":"refs/heads/master","isEnabled":false}

Enable Pages support for any new branch in the specified repository

PUT /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled-for-new-branches
 Example Request

curl -u username:password -H "Content-Type:application/json" -X PUT http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled-for-new-branches

 Example Response
{"repositoryId":1,"isEnabledForBranches":false,"isEnabledForTags":true}

Disable Pages support for new branches in the specified repository

DELETE /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled-for-new-branches
 Example Request

curl -u username:password -H "Content-Type:application/json" -X DELETE http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled-for-new-branches

 Example Response
{"repositoryId":1,"isEnabledForBranches":false,"isEnabledForTags":true}

Enable Pages support for any new tag in the specified repository

PUT /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled-for-new-tags
 Example Request

curl -u username:password -H "Content-Type:application/json" -X PUT http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled-for-new-tags

 Example Response
{"repositoryId":1,"isEnabledForBranches":false,"isEnabledForTags":true}

Disable Pages support for new tags in the specified repository

DELETE /rest/latest/pages-settings/{projectKey}/{repositorySlug}/enabled-for-new-tags
 Example Request

curl -u username:password -H "Content-Type:application/json" -X DELETE http://bitbucket.example.com/rest/latest/pages-settings/PROJECT_1/rep_1/enabled-for-new-tags

 Example Response
{"repositoryId":1,"isEnabledForBranches":false,"isEnabledForTags":false}
  • No labels