ATatlassian
Branch restrictions

List branch restrictions

Changed on

Returns a paginated list of all branch restrictions on the repository.

get/repositories/{workspace}/{repo_slug}/branch-restrictions

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/branch-restrictions
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: repository:admin
    • or HTTP basic
    • or API key in header Authorization

Query parameters

kindstring

Branch restrictions of this type

patternstring

Branch restrictions applied to branches of this pattern

Response

A paginated list of branch restrictions

sizeinteger

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

pageinteger

Page number of the current results. This is an optional element that is not provided in all responses.

pageleninteger

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

nextstring uri

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

previousstring uri

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

Changes

  • 5748cb124a33Revision changes
    • info

      added the optional property /// to the response with the status

  • 8c7911c0a910Revision changes
    • info

      added the optional property //////// to the response with the status