Pages for Bitbucket Server REST API

Pages for Bitbucket Server REST API


Get status of whether Pages is enabled for specified repository and branch/tag

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

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

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

Enable Pages for specified repository and branch/tag

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

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

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

Disable Pages for specific repository and branch/tag

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

    curl -u username:password -H "Content-Type:application/json" -X DELETE http://bitbucket.example.com/rest/pages/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/pages/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/pages/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/pages/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/pages/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/pages/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/pages/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/pages/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/pages/latest/pages-settings/PROJECT_1/rep_1/enabled-for-new-tags
  • Example Response

    {"repositoryId":1,"isEnabledForBranches":false,"isEnabledForTags":false}

 

 

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.