bitbucket-api-client-lib

PipelinesApi

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
createPipelineForRepository	POST /repositories/{workspace}/{repo_slug}/pipelines/
createPipelineVariableForTeam	POST /teams/{username}/pipelines_config/variables/
createPipelineVariableForUser	POST /users/{selected_user}/pipelines_config/variables/
createPipelineVariableForWorkspace	POST /workspaces/{workspace}/pipelines-config/variables
createRepositoryPipelineKnownHost	POST /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/
createRepositoryPipelineSchedule	POST /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/
createRepositoryPipelineVariable	POST /repositories/{workspace}/{repo_slug}/pipelines_config/variables/
deleteDeploymentVariable	DELETE /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
deletePipelineVariableForTeam	DELETE /teams/{username}/pipelines_config/variables/{variable_uuid}
deletePipelineVariableForUser	DELETE /users/{selected_user}/pipelines_config/variables/{variable_uuid}
deletePipelineVariableForWorkspace	DELETE /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
deleteRepositoryPipelineCache	DELETE /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}
deleteRepositoryPipelineKeyPair	DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
deleteRepositoryPipelineKnownHost	DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
deleteRepositoryPipelineSchedule	DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
deleteRepositoryPipelineVariable	DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
getDeploymentVariables	GET /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables
getPipelineForRepository	GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}
getPipelineStepForRepository	GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}
getPipelineStepLogForRepository	GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log
getPipelineStepsForRepository	GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/
getPipelineVariableForTeam	GET /teams/{username}/pipelines_config/variables/{variable_uuid}
getPipelineVariableForUser	GET /users/{selected_user}/pipelines_config/variables/{variable_uuid}
getPipelineVariableForWorkspace	GET /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
getPipelineVariablesForTeam	GET /teams/{username}/pipelines_config/variables/
getPipelineVariablesForUser	GET /users/{selected_user}/pipelines_config/variables/
getPipelineVariablesForWorkspace	GET /workspaces/{workspace}/pipelines-config/variables
getPipelinesForRepository	GET /repositories/{workspace}/{repo_slug}/pipelines/
getRepositoryPipelineCacheContentURI	GET /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri
getRepositoryPipelineCaches	GET /repositories/{workspace}/{repo_slug}/pipelines-config/caches/
getRepositoryPipelineConfig	GET /repositories/{workspace}/{repo_slug}/pipelines_config
getRepositoryPipelineKnownHost	GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
getRepositoryPipelineKnownHosts	GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/
getRepositoryPipelineSchedule	GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
getRepositoryPipelineScheduleExecutions	GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/
getRepositoryPipelineSchedules	GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/
getRepositoryPipelineSshKeyPair	GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
getRepositoryPipelineVariable	GET /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
getRepositoryPipelineVariables	GET /repositories/{workspace}/{repo_slug}/pipelines_config/variables/
stopPipeline	POST /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline
updateDeploymentVariable	PUT /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
updatePipelineVariableForTeam	PUT /teams/{username}/pipelines_config/variables/{variable_uuid}
updatePipelineVariableForUser	PUT /users/{selected_user}/pipelines_config/variables/{variable_uuid}
updatePipelineVariableForWorkspace	PUT /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
updateRepositoryBuildNumber	PUT /repositories/{workspace}/{repo_slug}/pipelines_config/build_number
updateRepositoryPipelineConfig	PUT /repositories/{workspace}/{repo_slug}/pipelines_config
updateRepositoryPipelineKeyPair	PUT /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
updateRepositoryPipelineKnownHost	PUT /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
updateRepositoryPipelineSchedule	PUT /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
updateRepositoryPipelineVariable	PUT /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}

createDeploymentVariable

DeploymentVariable createDeploymentVariable(body, username, repoSlug, environmentUuid, variableUuid)

Create a deployment environment level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
DeploymentVariable body = new DeploymentVariable(); // DeploymentVariable | The variable to create
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to update.
try {
    DeploymentVariable result = apiInstance.createDeploymentVariable(body, username, repoSlug, environmentUuid, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createDeploymentVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	DeploymentVariable	The variable to create
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment.
variableUuid	String	The UUID of the variable to update.

Return type

DeploymentVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createPipelineForRepository

Pipeline createPipelineForRepository(body, username, repoSlug)

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\": \"**\" } } }' ```

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
Pipeline body = new Pipeline(); // Pipeline | The pipeline to initiate.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    Pipeline result = apiInstance.createPipelineForRepository(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createPipelineForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Pipeline	The pipeline to initiate.
username	String	The account.
repoSlug	String	The repository.

Return type

Pipeline

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createPipelineVariableForTeam

PipelineVariable createPipelineVariableForTeam(username, body)

Create an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The variable to create.
try {
    PipelineVariable result = apiInstance.createPipelineVariableForTeam(username, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createPipelineVariableForTeam");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
body	PipelineVariable	The variable to create.	[optional]

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createPipelineVariableForUser

PipelineVariable createPipelineVariableForUser(selectedUser, body)

Create a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String selectedUser = "selectedUser_example"; // String | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The variable to create.
try {
    PipelineVariable result = apiInstance.createPipelineVariableForUser(selectedUser, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createPipelineVariableForUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
selectedUser	String	Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
body	PipelineVariable	The variable to create.	[optional]

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createPipelineVariableForWorkspace

PipelineVariable createPipelineVariableForWorkspace(workspace, body)

Create a workspace level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The variable to create.
try {
    PipelineVariable result = apiInstance.createPipelineVariableForWorkspace(workspace, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createPipelineVariableForWorkspace");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
body	PipelineVariable	The variable to create.	[optional]

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createRepositoryPipelineKnownHost

PipelineKnownHost createRepositoryPipelineKnownHost(body, username, repoSlug)

Create a repository level known host.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineKnownHost body = new PipelineKnownHost(); // PipelineKnownHost | The known host to create.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineKnownHost result = apiInstance.createRepositoryPipelineKnownHost(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createRepositoryPipelineKnownHost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineKnownHost	The known host to create.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineKnownHost

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createRepositoryPipelineSchedule

PipelineSchedule createRepositoryPipelineSchedule(body, username, repoSlug)

Create a schedule for the given repository.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineSchedule body = new PipelineSchedule(); // PipelineSchedule | The schedule to create.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineSchedule result = apiInstance.createRepositoryPipelineSchedule(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createRepositoryPipelineSchedule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineSchedule	The schedule to create.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineSchedule

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createRepositoryPipelineVariable

PipelineVariable createRepositoryPipelineVariable(body, username, repoSlug)

Create a repository level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The variable to create.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineVariable result = apiInstance.createRepositoryPipelineVariable(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#createRepositoryPipelineVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineVariable	The variable to create.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteDeploymentVariable

deleteDeploymentVariable(username, repoSlug, environmentUuid, variableUuid)

Delete a deployment environment level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to delete.
try {
    apiInstance.deleteDeploymentVariable(username, repoSlug, environmentUuid, variableUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteDeploymentVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment.
variableUuid	String	The UUID of the variable to delete.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deletePipelineVariableForTeam

deletePipelineVariableForTeam(username, variableUuid)

Delete a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to delete.
try {
    apiInstance.deletePipelineVariableForTeam(username, variableUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deletePipelineVariableForTeam");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
variableUuid	String	The UUID of the variable to delete.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deletePipelineVariableForUser

deletePipelineVariableForUser(selectedUser, variableUuid)

Delete an account level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String selectedUser = "selectedUser_example"; // String | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to delete.
try {
    apiInstance.deletePipelineVariableForUser(selectedUser, variableUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deletePipelineVariableForUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deletePipelineVariableForWorkspace

deletePipelineVariableForWorkspace(workspace, variableUuid)

Delete a workspace level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to delete.
try {
    apiInstance.deletePipelineVariableForWorkspace(workspace, variableUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deletePipelineVariableForWorkspace");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteRepositoryPipelineCache

deleteRepositoryPipelineCache(workspace, repoSlug, cacheUuid)

Delete a repository cache.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String cacheUuid = "cacheUuid_example"; // String | The UUID of the cache to delete.
try {
    apiInstance.deleteRepositoryPipelineCache(workspace, repoSlug, cacheUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteRepositoryPipelineCache");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	The account.
repoSlug	String	The repository.
cacheUuid	String	The UUID of the cache to delete.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteRepositoryPipelineKeyPair

deleteRepositoryPipelineKeyPair(username, repoSlug)

Delete the repository SSH key pair.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    apiInstance.deleteRepositoryPipelineKeyPair(username, repoSlug);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteRepositoryPipelineKeyPair");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteRepositoryPipelineKnownHost

deleteRepositoryPipelineKnownHost(username, repoSlug, knownHostUuid)

Delete a repository level known host.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String knownHostUuid = "knownHostUuid_example"; // String | The UUID of the known host to delete.
try {
    apiInstance.deleteRepositoryPipelineKnownHost(username, repoSlug, knownHostUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteRepositoryPipelineKnownHost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
knownHostUuid	String	The UUID of the known host to delete.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteRepositoryPipelineSchedule

deleteRepositoryPipelineSchedule(username, repoSlug, scheduleUuid)

Delete a schedule.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String scheduleUuid = "scheduleUuid_example"; // String | The uuid of the schedule.
try {
    apiInstance.deleteRepositoryPipelineSchedule(username, repoSlug, scheduleUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteRepositoryPipelineSchedule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
scheduleUuid	String	The uuid of the schedule.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteRepositoryPipelineVariable

deleteRepositoryPipelineVariable(username, repoSlug, variableUuid)

Delete a repository level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to delete.
try {
    apiInstance.deleteRepositoryPipelineVariable(username, repoSlug, variableUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#deleteRepositoryPipelineVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
variableUuid	String	The UUID of the variable to delete.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getDeploymentVariables

PaginatedDeploymentVariable getDeploymentVariables(username, repoSlug, environmentUuid)

Find deployment environment level variables.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment.
try {
    PaginatedDeploymentVariable result = apiInstance.getDeploymentVariables(username, repoSlug, environmentUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getDeploymentVariables");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment.

Return type

PaginatedDeploymentVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineForRepository

Pipeline getPipelineForRepository(username, repoSlug, pipelineUuid)

Retrieve a specified pipeline

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String pipelineUuid = "pipelineUuid_example"; // String | The pipeline UUID.
try {
    Pipeline result = apiInstance.getPipelineForRepository(username, repoSlug, pipelineUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
pipelineUuid	String	The pipeline UUID.

Return type

Pipeline

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineStepForRepository

PipelineStep getPipelineStepForRepository(username, repoSlug, pipelineUuid, stepUuid)

Retrieve a given step of a pipeline.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String pipelineUuid = "pipelineUuid_example"; // String | The UUID of the pipeline.
String stepUuid = "stepUuid_example"; // String | The UUID of the step.
try {
    PipelineStep result = apiInstance.getPipelineStepForRepository(username, repoSlug, pipelineUuid, stepUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineStepForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
pipelineUuid	String	The UUID of the pipeline.
stepUuid	String	The UUID of the step.

Return type

PipelineStep

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineStepLogForRepository

getPipelineStepLogForRepository(username, repoSlug, pipelineUuid, stepUuid)

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.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String pipelineUuid = "pipelineUuid_example"; // String | The UUID of the pipeline.
String stepUuid = "stepUuid_example"; // String | The UUID of the step.
try {
    apiInstance.getPipelineStepLogForRepository(username, repoSlug, pipelineUuid, stepUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineStepLogForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
pipelineUuid	String	The UUID of the pipeline.
stepUuid	String	The UUID of the step.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

getPipelineStepsForRepository

PaginatedPipelineSteps getPipelineStepsForRepository(username, repoSlug, pipelineUuid)

Find steps for the given pipeline.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String pipelineUuid = "pipelineUuid_example"; // String | The UUID of the pipeline.
try {
    PaginatedPipelineSteps result = apiInstance.getPipelineStepsForRepository(username, repoSlug, pipelineUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineStepsForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
pipelineUuid	String	The UUID of the pipeline.

Return type

PaginatedPipelineSteps

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariableForTeam

PipelineVariable getPipelineVariableForTeam(username, variableUuid)

Retrieve a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to retrieve.
try {
    PipelineVariable result = apiInstance.getPipelineVariableForTeam(username, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariableForTeam");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
variableUuid	String	The UUID of the variable to retrieve.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariableForUser

PipelineVariable getPipelineVariableForUser(selectedUser, variableUuid)

Retrieve a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String selectedUser = "selectedUser_example"; // String | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to retrieve.
try {
    PipelineVariable result = apiInstance.getPipelineVariableForUser(selectedUser, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariableForUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariableForWorkspace

PipelineVariable getPipelineVariableForWorkspace(workspace, variableUuid)

Retrieve a workspace level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to retrieve.
try {
    PipelineVariable result = apiInstance.getPipelineVariableForWorkspace(workspace, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariableForWorkspace");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariablesForTeam

PaginatedPipelineVariables getPipelineVariablesForTeam(username)

Find account level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
try {
    PaginatedPipelineVariables result = apiInstance.getPipelineVariablesForTeam(username);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariablesForTeam");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.

Return type

PaginatedPipelineVariables

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariablesForUser

PaginatedPipelineVariables getPipelineVariablesForUser(selectedUser)

Find user level variables. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String selectedUser = "selectedUser_example"; // String | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
try {
    PaginatedPipelineVariables result = apiInstance.getPipelineVariablesForUser(selectedUser);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariablesForUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
selectedUser	String	Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.

Return type

PaginatedPipelineVariables

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelineVariablesForWorkspace

PaginatedPipelineVariables getPipelineVariablesForWorkspace(workspace)

Find workspace level variables.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
try {
    PaginatedPipelineVariables result = apiInstance.getPipelineVariablesForWorkspace(workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelineVariablesForWorkspace");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.

Return type

PaginatedPipelineVariables

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPipelinesForRepository

PaginatedPipelines getPipelinesForRepository(username, repoSlug)

Find pipelines

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelines result = apiInstance.getPipelinesForRepository(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getPipelinesForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelines

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineCacheContentURI

PipelineCacheContentUri getRepositoryPipelineCacheContentURI(workspace, repoSlug, cacheUuid)

Retrieve the URI of the content of the specified cache.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String cacheUuid = "cacheUuid_example"; // String | The UUID of the cache.
try {
    PipelineCacheContentUri result = apiInstance.getRepositoryPipelineCacheContentURI(workspace, repoSlug, cacheUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineCacheContentURI");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	The account.
repoSlug	String	The repository.
cacheUuid	String	The UUID of the cache.

Return type

PipelineCacheContentUri

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineCaches

PaginatedPipelineCaches getRepositoryPipelineCaches(workspace, repoSlug)

Retrieve the repository pipelines caches.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelineCaches result = apiInstance.getRepositoryPipelineCaches(workspace, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineCaches");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelineCaches

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineConfig

PipelinesConfig getRepositoryPipelineConfig(workspace, repoSlug)

Retrieve the repository pipelines configuration.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String workspace = "workspace_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelinesConfig result = apiInstance.getRepositoryPipelineConfig(workspace, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	The account.
repoSlug	String	The repository.

Return type

PipelinesConfig

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineKnownHost

PipelineKnownHost getRepositoryPipelineKnownHost(username, repoSlug, knownHostUuid)

Retrieve a repository level known host.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String knownHostUuid = "knownHostUuid_example"; // String | The UUID of the known host to retrieve.
try {
    PipelineKnownHost result = apiInstance.getRepositoryPipelineKnownHost(username, repoSlug, knownHostUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineKnownHost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
knownHostUuid	String	The UUID of the known host to retrieve.

Return type

PipelineKnownHost

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineKnownHosts

PaginatedPipelineKnownHosts getRepositoryPipelineKnownHosts(username, repoSlug)

Find repository level known hosts.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelineKnownHosts result = apiInstance.getRepositoryPipelineKnownHosts(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineKnownHosts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelineKnownHosts

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineSchedule

PipelineSchedule getRepositoryPipelineSchedule(username, repoSlug, scheduleUuid)

Retrieve a schedule by its UUID.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String scheduleUuid = "scheduleUuid_example"; // String | The uuid of the schedule.
try {
    PipelineSchedule result = apiInstance.getRepositoryPipelineSchedule(username, repoSlug, scheduleUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineSchedule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
scheduleUuid	String	The uuid of the schedule.

Return type

PipelineSchedule

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineScheduleExecutions

PaginatedPipelineScheduleExecutions getRepositoryPipelineScheduleExecutions(username, repoSlug)

Retrieve the executions of a given schedule.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelineScheduleExecutions result = apiInstance.getRepositoryPipelineScheduleExecutions(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineScheduleExecutions");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelineScheduleExecutions

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineSchedules

PaginatedPipelineSchedules getRepositoryPipelineSchedules(username, repoSlug)

Retrieve the configured schedules for the given repository.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelineSchedules result = apiInstance.getRepositoryPipelineSchedules(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineSchedules");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelineSchedules

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineSshKeyPair

PipelineSshKeyPair getRepositoryPipelineSshKeyPair(username, repoSlug)

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.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineSshKeyPair result = apiInstance.getRepositoryPipelineSshKeyPair(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineSshKeyPair");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineSshKeyPair

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineVariable

PipelineVariable getRepositoryPipelineVariable(username, repoSlug, variableUuid)

Retrieve a repository level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to retrieve.
try {
    PipelineVariable result = apiInstance.getRepositoryPipelineVariable(username, repoSlug, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
variableUuid	String	The UUID of the variable to retrieve.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRepositoryPipelineVariables

PaginatedPipelineVariables getRepositoryPipelineVariables(username, repoSlug)

Find repository level variables.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedPipelineVariables result = apiInstance.getRepositoryPipelineVariables(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#getRepositoryPipelineVariables");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedPipelineVariables

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

stopPipeline

stopPipeline(username, repoSlug, pipelineUuid)

Signal the stop of a pipeline and all of its steps that not have completed yet.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String pipelineUuid = "pipelineUuid_example"; // String | The UUID of the pipeline.
try {
    apiInstance.stopPipeline(username, repoSlug, pipelineUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#stopPipeline");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
pipelineUuid	String	The UUID of the pipeline.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateDeploymentVariable

DeploymentVariable updateDeploymentVariable(body, username, repoSlug, environmentUuid, variableUuid)

Update a deployment environment level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
DeploymentVariable body = new DeploymentVariable(); // DeploymentVariable | The updated deployment variable.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to update.
try {
    DeploymentVariable result = apiInstance.updateDeploymentVariable(body, username, repoSlug, environmentUuid, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateDeploymentVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	DeploymentVariable	The updated deployment variable.
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment.
variableUuid	String	The UUID of the variable to update.

Return type

DeploymentVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updatePipelineVariableForTeam

PipelineVariable updatePipelineVariableForTeam(body, username, variableUuid)

Update a team level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The updated variable.
String username = "username_example"; // String | The account.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable.
try {
    PipelineVariable result = apiInstance.updatePipelineVariableForTeam(body, username, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updatePipelineVariableForTeam");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineVariable	The updated variable.
username	String	The account.
variableUuid	String	The UUID of the variable.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updatePipelineVariableForUser

PipelineVariable updatePipelineVariableForUser(body, selectedUser, variableUuid)

Update a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The updated variable.
String selectedUser = "selectedUser_example"; // String | Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable.
try {
    PipelineVariable result = apiInstance.updatePipelineVariableForUser(body, selectedUser, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updatePipelineVariableForUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updatePipelineVariableForWorkspace

PipelineVariable updatePipelineVariableForWorkspace(body, workspace, variableUuid)

Update a workspace level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The updated variable.
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable.
try {
    PipelineVariable result = apiInstance.updatePipelineVariableForWorkspace(body, workspace, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updatePipelineVariableForWorkspace");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryBuildNumber

PipelineBuildNumber updateRepositoryBuildNumber(body, username, repoSlug)

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.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineBuildNumber body = new PipelineBuildNumber(); // PipelineBuildNumber | The build number to update.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineBuildNumber result = apiInstance.updateRepositoryBuildNumber(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryBuildNumber");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineBuildNumber	The build number to update.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineBuildNumber

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryPipelineConfig

PipelinesConfig updateRepositoryPipelineConfig(body, username, repoSlug)

Update the pipelines configuration for a repository.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelinesConfig body = new PipelinesConfig(); // PipelinesConfig | The updated repository pipelines configuration.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelinesConfig result = apiInstance.updateRepositoryPipelineConfig(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryPipelineConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelinesConfig	The updated repository pipelines configuration.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelinesConfig

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryPipelineKeyPair

PipelineSshKeyPair updateRepositoryPipelineKeyPair(body, username, repoSlug)

Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineSshKeyPair body = new PipelineSshKeyPair(); // PipelineSshKeyPair | The created or updated SSH key pair.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PipelineSshKeyPair result = apiInstance.updateRepositoryPipelineKeyPair(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryPipelineKeyPair");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineSshKeyPair	The created or updated SSH key pair.
username	String	The account.
repoSlug	String	The repository.

Return type

PipelineSshKeyPair

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryPipelineKnownHost

PipelineKnownHost updateRepositoryPipelineKnownHost(body, username, repoSlug, knownHostUuid)

Update a repository level known host.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineKnownHost body = new PipelineKnownHost(); // PipelineKnownHost | The updated known host.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String knownHostUuid = "knownHostUuid_example"; // String | The UUID of the known host to update.
try {
    PipelineKnownHost result = apiInstance.updateRepositoryPipelineKnownHost(body, username, repoSlug, knownHostUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryPipelineKnownHost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineKnownHost	The updated known host.
username	String	The account.
repoSlug	String	The repository.
knownHostUuid	String	The UUID of the known host to update.

Return type

PipelineKnownHost

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryPipelineSchedule

PipelineSchedule updateRepositoryPipelineSchedule(body, username, repoSlug, scheduleUuid)

Update a schedule.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineSchedule body = new PipelineSchedule(); // PipelineSchedule | The schedule to update.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String scheduleUuid = "scheduleUuid_example"; // String | The uuid of the schedule.
try {
    PipelineSchedule result = apiInstance.updateRepositoryPipelineSchedule(body, username, repoSlug, scheduleUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryPipelineSchedule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineSchedule	The schedule to update.
username	String	The account.
repoSlug	String	The repository.
scheduleUuid	String	The uuid of the schedule.

Return type

PipelineSchedule

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateRepositoryPipelineVariable

PipelineVariable updateRepositoryPipelineVariable(body, username, repoSlug, variableUuid)

Update a repository level variable.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.PipelinesApi;


PipelinesApi apiInstance = new PipelinesApi();
PipelineVariable body = new PipelineVariable(); // PipelineVariable | The updated variable
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String variableUuid = "variableUuid_example"; // String | The UUID of the variable to update.
try {
    PipelineVariable result = apiInstance.updateRepositoryPipelineVariable(body, username, repoSlug, variableUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PipelinesApi#updateRepositoryPipelineVariable");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	PipelineVariable	The updated variable
username	String	The account.
repoSlug	String	The repository.
variableUuid	String	The UUID of the variable to update.

Return type

PipelineVariable

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

This site is open source. Improve this page.