All URIs are relative to https://api.bitbucket.org/2.0
| Method | HTTP request | Description |
|---|---|---|
| CreateDeploymentVariable | Post /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables | Create a variable for an environment |
| CreatePipelineForRepository | Post /repositories/{workspace}/{repo_slug}/pipelines | Run a pipeline |
| CreatePipelineVariableForTeam | Post /teams/{username}/pipelines_config/variables | Create a variable for a user |
| CreatePipelineVariableForUser | Post /users/{selected_user}/pipelines_config/variables | Create a variable for a user |
| CreatePipelineVariableForWorkspace | Post /workspaces/{workspace}/pipelines-config/variables | Create a variable for a workspace |
| CreateRepositoryPipelineKnownHost | Post /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts | Create a known host |
| CreateRepositoryPipelineSchedule | Post /repositories/{workspace}/{repo_slug}/pipelines_config/schedules | Create a schedule |
| CreateRepositoryPipelineVariable | Post /repositories/{workspace}/{repo_slug}/pipelines_config/variables | Create a variable for a repository |
| DeleteDeploymentVariable | Delete /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} | Delete a variable for an environment |
| DeletePipelineVariableForTeam | Delete /teams/{username}/pipelines_config/variables/{variable_uuid} | Delete a variable for a team |
| DeletePipelineVariableForUser | Delete /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Delete a variable for a user |
| DeletePipelineVariableForWorkspace | Delete /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Delete a variable for a workspace |
| DeleteRepositoryPipelineCache | Delete /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid} | Delete a cache |
| DeleteRepositoryPipelineCaches | Delete /repositories/{workspace}/{repo_slug}/pipelines-config/caches | Delete caches |
| DeleteRepositoryPipelineKeyPair | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Delete SSH key pair |
| DeleteRepositoryPipelineKnownHost | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Delete a known host |
| DeleteRepositoryPipelineSchedule | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Delete a schedule |
| DeleteRepositoryPipelineVariable | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Delete a variable for a repository |
| GetDeploymentVariables | Get /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables | List variables for an environment |
| GetOIDCConfiguration | Get /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration | Get OpenID configuration for OIDC in Pipelines |
| GetOIDCKeys | Get /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json | Get keys for OIDC in Pipelines |
| GetPipelineContainerLog | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid} | Get the logs for the build container or a service container for a given step of a pipeline. |
| GetPipelineForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid} | Get a pipeline |
| GetPipelineStepForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid} | Get a step of a pipeline |
| GetPipelineStepLogForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log | Get log file for a step |
| GetPipelineStepsForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps | List steps for a pipeline |
| GetPipelineTestReportTestCaseReasons | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons | Get test case reasons (output) for a given test case in a step of a pipeline. |
| GetPipelineTestReportTestCases | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases | Get test cases for a given step of a pipeline. |
| GetPipelineTestReports | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports | Get a summary of test reports for a given step of a pipeline. |
| GetPipelineVariableForTeam | Get /teams/{username}/pipelines_config/variables/{variable_uuid} | Get a variable for a team |
| GetPipelineVariableForUser | Get /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Get a variable for a user |
| GetPipelineVariableForWorkspace | Get /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Get variable for a workspace |
| GetPipelineVariablesForTeam | Get /teams/{username}/pipelines_config/variables | List variables for an account |
| GetPipelineVariablesForUser | Get /users/{selected_user}/pipelines_config/variables | List variables for a user |
| GetPipelineVariablesForWorkspace | Get /workspaces/{workspace}/pipelines-config/variables | List variables for a workspace |
| GetPipelinesForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines | List pipelines |
| GetRepositoryPipelineCacheContentURI | Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri | Get cache content URI |
| GetRepositoryPipelineCaches | Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches | List caches |
| GetRepositoryPipelineConfig | Get /repositories/{workspace}/{repo_slug}/pipelines_config | Get configuration |
| GetRepositoryPipelineKnownHost | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Get a known host |
| GetRepositoryPipelineKnownHosts | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts | List known hosts |
| GetRepositoryPipelineSchedule | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Get a schedule |
| GetRepositoryPipelineScheduleExecutions | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions | List executions of a schedule |
| GetRepositoryPipelineSchedules | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules | List schedules |
| GetRepositoryPipelineSshKeyPair | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Get SSH key pair |
| GetRepositoryPipelineVariable | Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Get a variable for a repository |
| GetRepositoryPipelineVariables | Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables | List variables for a repository |
| StopPipeline | Post /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline | Stop a pipeline |
| UpdateDeploymentVariable | Put /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} | Update a variable for an environment |
| UpdatePipelineVariableForTeam | Put /teams/{username}/pipelines_config/variables/{variable_uuid} | Update a variable for a team |
| UpdatePipelineVariableForUser | Put /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Update a variable for a user |
| UpdatePipelineVariableForWorkspace | Put /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Update variable for a workspace |
| UpdateRepositoryBuildNumber | Put /repositories/{workspace}/{repo_slug}/pipelines_config/build_number | Update the next build number |
| UpdateRepositoryPipelineConfig | Put /repositories/{workspace}/{repo_slug}/pipelines_config | Update configuration |
| UpdateRepositoryPipelineKeyPair | Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Update SSH key pair |
| UpdateRepositoryPipelineKnownHost | Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Update a known host |
| UpdateRepositoryPipelineSchedule | Put /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Update a schedule |
| UpdateRepositoryPipelineVariable | Put /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Update a variable for a repository |
DeploymentVariable CreateDeploymentVariable(ctx, body, workspace, repoSlug, environmentUuid) Create a variable for an environment
Create a deployment environment level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | DeploymentVariable | The variable to create | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| environmentUuid | string | The environment. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Pipeline CreatePipelineForRepository(ctx, body, workspace, repoSlug) Run a pipeline
Endpoint to create and initiate a pipeline. There are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated. # Trigger a Pipeline for a branch One way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline. The specified branch will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch. ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\ -d ' { \"target\": { \"ref_type\": \"branch\", \"type\": \"pipeline_ref_target\", \"ref_name\": \"master\" } }' # Trigger a Pipeline for a commit on a branch or tag You can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark). The specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference. The following reference types are supported: * branch * named_branch * bookmark * tag ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\ -d ' { \"target\": { \"commit\": { \"type\": \"commit\", \"hash\": \"ce5b7431602f7cbba007062eeb55225c6e18e956\" }, \"ref_type\": \"branch\", \"type\": \"pipeline_ref_target\", \"ref_name\": \"master\" } }' # Trigger a specific pipeline definition for a commit You can trigger a specific pipeline that is defined in your bitbucket-pipelines.yml file for a specific commit. In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision. ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\ -d ' { \"target\": { \"commit\": { \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\", \"type\":\"commit\" }, \"selector\": { \"type\":\"custom\", \"pattern\":\"Deploy to production\" }, \"type\":\"pipeline_commit_target\" } }' # Trigger a specific pipeline definition for a commit on a branch or tag You can trigger a specific pipeline that is defined in your bitbucket-pipelines.yml file for a specific commit in the context of a specified reference. In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference. ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\ -d ' { \"target\": { \"commit\": { \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\", \"type\":\"commit\" }, \"selector\": { \"type\": \"custom\", \"pattern\": \"Deploy to production\" }, \"type\": \"pipeline_ref_target\", \"ref_name\": \"master\", \"ref_type\": \"branch\" } }' # Trigger a custom pipeline with variables In addition to triggering a custom pipeline that is defined in your bitbucket-pipelines.yml file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured). ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\ -d ' { \"target\": { \"type\": \"pipeline_ref_target\", \"ref_type\": \"branch\", \"ref_name\": \"master\", \"selector\": { \"type\": \"custom\", \"pattern\": \"Deploy to production\" } }, \"variables\": [ { \"key\": \"var1key\", \"value\": \"var1value\", \"secured\": true }, { \"key\": \"var2key\", \"value\": \"var2value\" } ] }' # Trigger a pull request pipeline You can also initiate a pipeline for a specific pull request. ### Example $ curl -X POST -is -u username:password \\ -H 'Content-Type: application/json' \\ https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\ -d ' { \"target\": { \"type\": \"pipeline_pullrequest_target\", \"source\": \"pull-request-branch\", \"destination\": \"master\", \"destination_commit\": { \"hash\" : \"9f848b7\" }, \"commit\": { \"hash\" : \"1a372fc\" }, \"pullrequest\" : { \"id\" : \"3\" }, \"selector\": { \"type\": \"pull-requests\", \"pattern\": \"**\" } } }'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | Pipeline | The pipeline to initiate. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable CreatePipelineVariableForTeam(ctx, username, optional) Create a variable for a user
Create an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| username | string | The account. | |
| optional | *PipelinesApiCreatePipelineVariableForTeamOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiCreatePipelineVariableForTeamOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of PipelineVariable| The variable to create. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable CreatePipelineVariableForUser(ctx, selectedUser, optional) Create a variable for a user
Create a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| selectedUser | string | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. | |
| optional | *PipelinesApiCreatePipelineVariableForUserOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiCreatePipelineVariableForUserOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of PipelineVariable| The variable to create. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable CreatePipelineVariableForWorkspace(ctx, workspace, optional) Create a variable for a workspace
Create a workspace level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| optional | *PipelinesApiCreatePipelineVariableForWorkspaceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiCreatePipelineVariableForWorkspaceOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of PipelineVariable| The variable to create. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineKnownHost CreateRepositoryPipelineKnownHost(ctx, body, workspace, repoSlug) Create a known host
Create a repository level known host.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineKnownHost | The known host to create. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineSchedule CreateRepositoryPipelineSchedule(ctx, body, workspace, repoSlug) Create a schedule
Create a schedule for the given repository.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineSchedulePostRequestBody | The schedule to create. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable CreateRepositoryPipelineVariable(ctx, body, workspace, repoSlug) Create a variable for a repository
Create a repository level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineVariable | The variable to create. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDeploymentVariable(ctx, workspace, repoSlug, environmentUuid, variableUuid) Delete a variable for an environment
Delete a deployment environment level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| environmentUuid | string | The environment. | |
| variableUuid | string | The UUID of the variable to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePipelineVariableForTeam(ctx, username, variableUuid) Delete a variable for a team
Delete a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| username | string | The account. | |
| variableUuid | string | The UUID of the variable to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePipelineVariableForUser(ctx, selectedUser, variableUuid) Delete a variable for a user
Delete an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| selectedUser | string | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. | |
| variableUuid | string | The UUID of the variable to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePipelineVariableForWorkspace(ctx, workspace, variableUuid) Delete a variable for a workspace
Delete a workspace level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| variableUuid | string | The UUID of the variable to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineCache(ctx, workspace, repoSlug, cacheUuid) Delete a cache
Delete a repository cache.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | The account. | |
| repoSlug | string | The repository. | |
| cacheUuid | string | The UUID of the cache to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineCaches(ctx, workspace, repoSlug, name) Delete caches
Delete repository cache versions by name.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | The account. | |
| repoSlug | string | The repository. | |
| name | string | The cache name. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineKeyPair(ctx, workspace, repoSlug) Delete SSH key pair
Delete the repository SSH key pair.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineKnownHost(ctx, workspace, repoSlug, knownHostUuid) Delete a known host
Delete a repository level known host.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| knownHostUuid | string | The UUID of the known host to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineSchedule(ctx, workspace, repoSlug, scheduleUuid) Delete a schedule
Delete a schedule.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| scheduleUuid | string | The uuid of the schedule. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRepositoryPipelineVariable(ctx, workspace, repoSlug, variableUuid) Delete a variable for a repository
Delete a repository level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| variableUuid | string | The UUID of the variable to delete. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedDeploymentVariable GetDeploymentVariables(ctx, workspace, repoSlug, environmentUuid, optional) List variables for an environment
Find deployment environment level variables.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| environmentUuid | string | The environment. | |
| optional | *PipelinesApiGetDeploymentVariablesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetDeploymentVariablesOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOIDCConfiguration(ctx, workspace) Get OpenID configuration for OIDC in Pipelines
This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOIDCKeys(ctx, workspace) Get keys for OIDC in Pipelines
This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPipelineContainerLog(ctx, workspace, repoSlug, pipelineUuid, stepUuid, logUuid) Get the logs for the build container or a service container for a given step of a pipeline.
Retrieve the log file for a build container or service container. This endpoint supports (and encourages!) the use of HTTP Range requests to deal with potentially very large log files.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. | |
| logUuid | string | For the main build container specify the step UUID; for a service container specify the service container UUID |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Pipeline GetPipelineForRepository(ctx, workspace, repoSlug, pipelineUuid) Get a pipeline
Retrieve a specified pipeline
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The pipeline UUID. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineStep GetPipelineStepForRepository(ctx, workspace, repoSlug, pipelineUuid, stepUuid) Get a step of a pipeline
Retrieve a given step of a pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPipelineStepLogForRepository(ctx, workspace, repoSlug, pipelineUuid, stepUuid) Get log file for a step
Retrieve the log file for a given step of a pipeline. This endpoint supports (and encourages!) the use of HTTP Range requests to deal with potentially very large log files.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineSteps GetPipelineStepsForRepository(ctx, workspace, repoSlug, pipelineUuid, optional) List steps for a pipeline
Find steps for the given pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| optional | *PipelinesApiGetPipelineStepsForRepositoryOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetPipelineStepsForRepositoryOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPipelineTestReportTestCaseReasons(ctx, workspace, repoSlug, pipelineUuid, stepUuid, testCaseUuid) Get test case reasons (output) for a given test case in a step of a pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. | |
| testCaseUuid | string | The UUID of the test case. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPipelineTestReportTestCases(ctx, workspace, repoSlug, pipelineUuid, stepUuid) Get test cases for a given step of a pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPipelineTestReports(ctx, workspace, repoSlug, pipelineUuid, stepUuid) Get a summary of test reports for a given step of a pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. | |
| stepUuid | string | The UUID of the step. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable GetPipelineVariableForTeam(ctx, username, variableUuid) Get a variable for a team
Retrieve a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| username | string | The account. | |
| variableUuid | string | The UUID of the variable to retrieve. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable GetPipelineVariableForUser(ctx, selectedUser, variableUuid) Get a variable for a user
Retrieve a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| selectedUser | string | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. | |
| variableUuid | string | The UUID of the variable to retrieve. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable GetPipelineVariableForWorkspace(ctx, workspace, variableUuid) Get variable for a workspace
Retrieve a workspace level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| variableUuid | string | The UUID of the variable to retrieve. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineVariables GetPipelineVariablesForTeam(ctx, username, optional) List variables for an account
Find account level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| username | string | The account. | |
| optional | *PipelinesApiGetPipelineVariablesForTeamOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetPipelineVariablesForTeamOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineVariables GetPipelineVariablesForUser(ctx, selectedUser, optional) List variables for a user
Find user level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| selectedUser | string | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. | |
| optional | *PipelinesApiGetPipelineVariablesForUserOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetPipelineVariablesForUserOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineVariables GetPipelineVariablesForWorkspace(ctx, workspace, optional) List variables for a workspace
Find workspace level variables.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| optional | *PipelinesApiGetPipelineVariablesForWorkspaceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetPipelineVariablesForWorkspaceOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelines GetPipelinesForRepository(ctx, workspace, repoSlug, optional) List pipelines
Find pipelines
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| optional | *PipelinesApiGetPipelinesForRepositoryOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetPipelinesForRepositoryOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineCacheContentUri GetRepositoryPipelineCacheContentURI(ctx, workspace, repoSlug, cacheUuid) Get cache content URI
Retrieve the URI of the content of the specified cache.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | The account. | |
| repoSlug | string | The repository. | |
| cacheUuid | string | The UUID of the cache. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineCaches GetRepositoryPipelineCaches(ctx, workspace, repoSlug, optional) List caches
Retrieve the repository pipelines caches.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | The account. | |
| repoSlug | string | The repository. | |
| optional | *PipelinesApiGetRepositoryPipelineCachesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetRepositoryPipelineCachesOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelinesConfig GetRepositoryPipelineConfig(ctx, workspace, repoSlug) Get configuration
Retrieve the repository pipelines configuration.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | The account. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineKnownHost GetRepositoryPipelineKnownHost(ctx, workspace, repoSlug, knownHostUuid) Get a known host
Retrieve a repository level known host.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| knownHostUuid | string | The UUID of the known host to retrieve. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineKnownHosts GetRepositoryPipelineKnownHosts(ctx, workspace, repoSlug, optional) List known hosts
Find repository level known hosts.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| optional | *PipelinesApiGetRepositoryPipelineKnownHostsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetRepositoryPipelineKnownHostsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineSchedule GetRepositoryPipelineSchedule(ctx, workspace, repoSlug, scheduleUuid) Get a schedule
Retrieve a schedule by its UUID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| scheduleUuid | string | The uuid of the schedule. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineScheduleExecutions GetRepositoryPipelineScheduleExecutions(ctx, workspace, repoSlug, scheduleUuid, optional) List executions of a schedule
Retrieve the executions of a given schedule.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| scheduleUuid | string | The uuid of the schedule. | |
| optional | *PipelinesApiGetRepositoryPipelineScheduleExecutionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetRepositoryPipelineScheduleExecutionsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
PaginatedPipelineScheduleExecutions
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineSchedules GetRepositoryPipelineSchedules(ctx, workspace, repoSlug, optional) List schedules
Retrieve the configured schedules for the given repository.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| optional | *PipelinesApiGetRepositoryPipelineSchedulesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetRepositoryPipelineSchedulesOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineSshKeyPair GetRepositoryPipelineSshKeyPair(ctx, workspace, repoSlug) Get SSH key pair
Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable GetRepositoryPipelineVariable(ctx, workspace, repoSlug, variableUuid) Get a variable for a repository
Retrieve a repository level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| variableUuid | string | The UUID of the variable to retrieve. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaginatedPipelineVariables GetRepositoryPipelineVariables(ctx, workspace, repoSlug, optional) List variables for a repository
Find repository level variables.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| optional | *PipelinesApiGetRepositoryPipelineVariablesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PipelinesApiGetRepositoryPipelineVariablesOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StopPipeline(ctx, workspace, repoSlug, pipelineUuid) Stop a pipeline
Signal the stop of a pipeline and all of its steps that not have completed yet.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| pipelineUuid | string | The UUID of the pipeline. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeploymentVariable UpdateDeploymentVariable(ctx, body, workspace, repoSlug, environmentUuid, variableUuid) Update a variable for an environment
Update a deployment environment level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | DeploymentVariable | The updated deployment variable. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| environmentUuid | string | The environment. | |
| variableUuid | string | The UUID of the variable to update. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable UpdatePipelineVariableForTeam(ctx, body, username, variableUuid) Update a variable for a team
Update a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineVariable | The updated variable. | |
| username | string | The account. | |
| variableUuid | string | The UUID of the variable. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable UpdatePipelineVariableForUser(ctx, body, selectedUser, variableUuid) Update a variable for a user
Update a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineVariable | The updated variable. | |
| selectedUser | string | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. | |
| variableUuid | string | The UUID of the variable. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable UpdatePipelineVariableForWorkspace(ctx, body, workspace, variableUuid) Update variable for a workspace
Update a workspace level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineVariable | The updated variable. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| variableUuid | string | The UUID of the variable. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineBuildNumber UpdateRepositoryBuildNumber(ctx, body, workspace, repoSlug) Update the next build number
Update the next build number that should be assigned to a pipeline. The next build number that will be configured has to be strictly higher than the current latest build number for this repository.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineBuildNumber | The build number to update. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelinesConfig UpdateRepositoryPipelineConfig(ctx, body, workspace, repoSlug) Update configuration
Update the pipelines configuration for a repository.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelinesConfig | The updated repository pipelines configuration. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineSshKeyPair UpdateRepositoryPipelineKeyPair(ctx, body, workspace, repoSlug) Update SSH key pair
Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineSshKeyPair | The created or updated SSH key pair. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineKnownHost UpdateRepositoryPipelineKnownHost(ctx, body, workspace, repoSlug, knownHostUuid) Update a known host
Update a repository level known host.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineKnownHost | The updated known host. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| knownHostUuid | string | The UUID of the known host to update. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineSchedule UpdateRepositoryPipelineSchedule(ctx, body, workspace, repoSlug, scheduleUuid) Update a schedule
Update a schedule.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineSchedulePutRequestBody | The schedule to update. | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| scheduleUuid | string | The uuid of the schedule. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PipelineVariable UpdateRepositoryPipelineVariable(ctx, body, workspace, repoSlug, variableUuid) Update a variable for a repository
Update a repository level variable.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PipelineVariable | The updated variable | |
| workspace | string | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | |
| repoSlug | string | The repository. | |
| variableUuid | string | The UUID of the variable to update. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]