/bitbucket/repositories/branches

POST /api/bitbucket/repositories/branches

Price: 10 credits

List branches of a Bitbucket repository by 'workspace/repo' or repository URL

How to use it

List the branches of a Bitbucket repository by 'workspace/repo' slug or repository URL, optionally filtered by name and sorted by name or last-commit date. Returns each branch name, its default merge strategy, available merge and sync strategies, and the target (head) commit with hash, message, date, and author.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• repo string required — Repository in 'workspace/repo' format or a Bitbucket repository URL (examples: "atlassian/aui", "https://bitbucket.org/atlassian/aui"; minLength: 1)
• count integer required — Number of branches to return (min: 1)
• query string nullable — Filter branches by name, e.g. 'name~"release"' (examples: "name~\"master\"")
• sort string — Sort branches by this field (default: "name"; one of: "name", "-name", "-target.date", "target.date")

Response

• @type string (default: "BitbucketBranch")
• name string required
• target object nullable
  • @type string (default: "BitbucketCommit")
  • hash string required
  • text string (default: "")
  • created_at string (default: "")
  • author_raw string (default: "")
  • author object nullable
    • @type string (default: "BitbucketAccount")
    • uuid string (default: "")
    • display_name string (default: "")
    • nickname string nullable
    • account_id string nullable
    • account_type string (default: "")
    • account_status string nullable
    • is_staff boolean (default: false)
    • location string nullable
    • created_at string nullable
    • image string nullable
    • web_url string (default: "")
  • parents array (default: [])
  • repository_alias string (default: "")
  • web_url string (default: "")
• default_merge_strategy string (default: "")
• merge_strategies array (default: [])
• sync_strategies array (default: [])
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Repository not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.