Liking cljdoc? Tell your friends :D

atlassian.bitbucket.client

Bitbucket client handle + the request seam every atlassian.bitbucket.* endpoint namespace is built on.

Bitbucket Cloud is a separate Atlassian service from Jira/Confluence: it lives on a fixed host (https://api.bitbucket.org/2.0) and uses its own credentials (see atlassian.config/bitbucket-config). Most resources are workspace- and repository-scoped, so endpoint functions take workspace and repo_slug as positional arguments and pass them in a path RELATIVE to the single API root:

(require '[atlassian.bitbucket.client :as bitbucket]) (def c (bitbucket/client)) (bitbucket/request c {:method :get :path "/repositories/your-workspace"}) (bitbucket/request c {:method :get :path "/repositories/your-workspace/your-repo/pullrequests" :query {:state "OPEN" :pagelen 25}})

There is a single API surface, so — unlike the Jira/Confluence clients — there is NO :api routing key.

Pagination differs from Jira and Confluence. List responses are {:values [...] :page N :pagelen N :size N :next "<full-url>" :previous "<full-url>"}. The :next link is a COMPLETE absolute URL (not a cursor), so paging fetches it directly; next-url extracts it and request-url fetches an absolute URL.

Bitbucket client handle + the `request` seam every atlassian.bitbucket.*
endpoint namespace is built on.

Bitbucket Cloud is a separate Atlassian service from Jira/Confluence: it lives
on a fixed host (https://api.bitbucket.org/2.0) and uses its own credentials
(see `atlassian.config/bitbucket-config`). Most resources are workspace- and
repository-scoped, so endpoint functions take `workspace` and `repo_slug` as
positional arguments and pass them in a path RELATIVE to the single API root:

  (require '[atlassian.bitbucket.client :as bitbucket])
  (def c (bitbucket/client))
  (bitbucket/request c {:method :get :path "/repositories/your-workspace"})
  (bitbucket/request c {:method :get
                        :path   "/repositories/your-workspace/your-repo/pullrequests"
                        :query  {:state "OPEN" :pagelen 25}})

There is a single API surface, so — unlike the Jira/Confluence clients — there
is NO `:api` routing key.

Pagination differs from Jira and Confluence. List responses are
`{:values [...] :page N :pagelen N :size N :next "<full-url>" :previous "<full-url>"}`.
The `:next` link is a COMPLETE absolute URL (not a cursor), so paging fetches it
directly; `next-url` extracts it and `request-url` fetches an absolute URL.
raw docstring

atlassian.bitbucket.issues

Bitbucket Cloud Issue Tracker endpoint functions.

All operations are workspace- and repository-scoped. Every function takes a client handle (from atlassian.bitbucket.client/client) as its first argument, followed by required path params, then an optional body (for write ops) and an optional opts map for query params.

Pagination: list responses return {:values [...] :next "<full-url>" ...}. Pass :page, :pagelen, :q, :sort, :fields in opts; follow :next via atlassian.bitbucket.client/request-url.

Bitbucket Cloud Issue Tracker endpoint functions.

All operations are workspace- and repository-scoped. Every function takes
a `client` handle (from `atlassian.bitbucket.client/client`) as its first
argument, followed by required path params, then an optional `body` (for
write ops) and an optional `opts` map for query params.

Pagination: list responses return `{:values [...] :next "<full-url>" ...}`.
Pass `:page`, `:pagelen`, `:q`, `:sort`, `:fields` in `opts`; follow `:next`
via `atlassian.bitbucket.client/request-url`.
raw docstring

atlassian.bitbucket.pipelines

Bitbucket Pipelines API — CI/CD pipeline management, configuration, runners, variables, SSH keys, caches, and OIDC identity.

Bitbucket Pipelines API — CI/CD pipeline management, configuration, runners,
variables, SSH keys, caches, and OIDC identity.
raw docstring

atlassian.bitbucket.projects

Bitbucket Cloud Projects API — workspace-scoped project management. All fns delegate to atlassian.bitbucket.client/request; no network is touched at load time. Pagination responses include :values, :page, :pagelen, :size, :next, :previous — follow :next via bitbucket/request-url.

Bitbucket Cloud Projects API — workspace-scoped project management.
All fns delegate to `atlassian.bitbucket.client/request`; no network is
touched at load time. Pagination responses include :values, :page, :pagelen,
:size, :next, :previous — follow :next via `bitbucket/request-url`.
raw docstring

atlassian.bitbucket.pullrequests

Bitbucket Cloud pull-requests API endpoint functions.

All functions take a client (from atlassian.bitbucket.client/client) as their first argument, followed by required path params positionally, then an optional body (for write ops) and/or an opts map for query params.

Pagination: list endpoints return {:values [...] :next "<full-url>" ...}. Pass page, pagelen, q, sort, fields in opts; follow :next via atlassian.bitbucket.client/request-url.

Bitbucket Cloud pull-requests API endpoint functions.

All functions take a `client` (from `atlassian.bitbucket.client/client`) as
their first argument, followed by required path params positionally, then an
optional `body` (for write ops) and/or an `opts` map for query params.

Pagination: list endpoints return `{:values [...] :next "<full-url>" ...}`.
Pass `page`, `pagelen`, `q`, `sort`, `fields` in opts; follow `:next` via
`atlassian.bitbucket.client/request-url`.
raw docstring

atlassian.bitbucket.refs

Bitbucket refs, branch-restrictions, and branching-model endpoint functions.

Covers:

  • Branch restrictions (/repositories/{workspace}/{repo_slug}/branch-restrictions)
  • Branching model (/repositories/{workspace}/{repo_slug}/branching-model)
  • Refs / branches / tags (/repositories/{workspace}/{repo_slug}/refs/...)
  • Project branching model (/workspaces/{workspace}/projects/{project_key}/branching-model)

Every fn delegates to atlassian.bitbucket.client/request. There is a single API surface — no :api key is used. Paginated list responses return {:values [...] :next "<full-url>" ...}; follow :next via atlassian.bitbucket.client/request-url.

Bitbucket refs, branch-restrictions, and branching-model endpoint functions.

Covers:
  - Branch restrictions  (/repositories/{workspace}/{repo_slug}/branch-restrictions)
  - Branching model      (/repositories/{workspace}/{repo_slug}/branching-model)
  - Refs / branches / tags (/repositories/{workspace}/{repo_slug}/refs/...)
  - Project branching model (/workspaces/{workspace}/projects/{project_key}/branching-model)

Every fn delegates to `atlassian.bitbucket.client/request`. There is a single
API surface — no :api key is used. Paginated list responses return
{:values [...] :next "<full-url>" ...}; follow :next via
`atlassian.bitbucket.client/request-url`.
raw docstring

atlassian.bitbucket.repositories

Bitbucket Cloud Repositories API — repository management, downloads, forks, permission configs, and watchers over the single Bitbucket API surface.

All fns take a client (from atlassian.bitbucket.client/client) as the first argument. List endpoints return paginated responses of the shape {:values [...] :page N :pagelen N :size N :next "<full-url>" :previous "<full-url>"}.

Bitbucket Cloud Repositories API — repository management, downloads, forks,
permission configs, and watchers over the single Bitbucket API surface.

All fns take a `client` (from `atlassian.bitbucket.client/client`) as the
first argument. List endpoints return paginated responses of the shape
`{:values [...] :page N :pagelen N :size N :next "<full-url>" :previous "<full-url>"}`.
raw docstring

atlassian.bitbucket.search

Bitbucket Search API — code search across teams, users, and workspaces. All functions are GETs; pagination follows the standard Bitbucket pattern ({:values [...] :next "<full-url>" ...}). Pass query params via opts.

Bitbucket Search API — code search across teams, users, and workspaces.
All functions are GETs; pagination follows the standard Bitbucket pattern
({:values [...] :next "<full-url>" ...}). Pass query params via opts.
raw docstring

atlassian.bitbucket.source

Bitbucket Cloud Source / repository file-content endpoints.

All functions take a client handle (from atlassian.bitbucket.client/client) as their first argument, then the required path params, then an optional opts map for query params.

Pagination: list responses carry {:values [...] :next "<full-url>" ...}. Follow :next with atlassian.bitbucket.client/request-url.

Bitbucket Cloud Source / repository file-content endpoints.

All functions take a `client` handle (from `atlassian.bitbucket.client/client`)
as their first argument, then the required path params, then an optional `opts`
map for query params.

Pagination: list responses carry {:values [...] :next "<full-url>" ...}.
Follow :next with `atlassian.bitbucket.client/request-url`.
raw docstring

atlassian.bitbucket.webhooks

Bitbucket webhooks API — subscription and event-type management.

All functions take a client as their first argument (from atlassian.bitbucket.client/client). Path params are positional; query params and optional options go in a trailing opts map (default {}). Write operations accept a body map before the opts map.

Pagination: list responses return {:values [...] :next "<full-url>" ...}. Pass :page, :pagelen, :q, :sort, :fields in opts; follow :next via atlassian.bitbucket.client/request-url.

Bitbucket webhooks API — subscription and event-type management.

All functions take a `client` as their first argument (from
`atlassian.bitbucket.client/client`). Path params are positional; query
params and optional options go in a trailing `opts` map (default `{}`).
Write operations accept a `body` map before the opts map.

Pagination: list responses return `{:values [...] :next "<full-url>" ...}`.
Pass `:page`, `:pagelen`, `:q`, `:sort`, `:fields` in `opts`; follow
`:next` via `atlassian.bitbucket.client/request-url`.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close