ATatlassian
Pipelines

Get workspace runners

Changed on

Retrieve workspace runners.

get/workspaces/{workspace}/pipelines-config/runners

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/workspaces/{workspace}/pipelines-config/runners
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: runner
    • or HTTP basic
    • or API key in header Authorization

Path parameters

workspacestring required

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

Response

The workspace runners.

pageinteger

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

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.

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

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

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