Skip to main content
Server path: /bitbucket-pipelines | Type: Application | PCID required: Yes

Tools


bitbucket_pipelines_create_environment

Create an environment Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
namestringNoThe name of the environment.
typestringYesThe type value
uuidstringNoThe UUID identifying the environment.

bitbucket_pipelines_create_pipeline

Run a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
build_numberintegerNoThe build number of the pipeline.
build_seconds_usedintegerNoThe number of build seconds used by this pipeline.
completed_onstringNoThe timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress.
configuration_sourcesobject[]NoAn ordered list of sources of the pipeline configuration
created_onstringNoThe timestamp when the pipeline was created.
creatorobjectNoThe creator value
linksobjectNoThe links value
repositoryobjectNoThe repository value
stateobjectNoThe state value
targetobjectNoThe target value
triggerobjectNoThe trigger value
typestringYesThe type value
uuidstringNoThe UUID identifying the pipeline.
variablesany[]NoThe variables for the pipeline.

bitbucket_pipelines_create_pipeline_variable

Create a variable for a repository Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
keystringNoThe unique name of the variable.
securedbooleanNoIf true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.
typestringYesThe type value
uuidstringNoThe UUID identifying the variable.
valuestringNoThe value of the variable. If the variable is secured, this will be empty.

bitbucket_pipelines_delete_environment

Delete an environment Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
environment_uuidstringYesThe environment UUID.

bitbucket_pipelines_get_deployment

Get a deployment Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
deployment_uuidstringYesThe deployment UUID.

bitbucket_pipelines_get_environment

Get an environment Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
environment_uuidstringYesThe environment UUID.

bitbucket_pipelines_get_pipeline

Get a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
pipeline_uuidstringYesThe pipeline UUID.

bitbucket_pipelines_get_pipeline_config

Get configuration Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThe account.
repo_slugstringYesThe repository.

bitbucket_pipelines_get_pipeline_step

Get a step of a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
pipeline_uuidstringYesThe UUID of the pipeline.
step_uuidstringYesThe UUID of the step.

bitbucket_pipelines_get_pipeline_step_log

Get log file for a step Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
pipeline_uuidstringYesThe UUID of the pipeline.
step_uuidstringYesThe UUID of the step.

bitbucket_pipelines_list_deployments

List deployments Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.

bitbucket_pipelines_list_environments

List environments Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.

bitbucket_pipelines_list_pipeline_steps

List steps for a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
pipeline_uuidstringYesThe UUID of the pipeline.

bitbucket_pipelines_list_pipeline_variables

List variables for a repository Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.

bitbucket_pipelines_list_pipelines

List pipelines Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
creator.uuidstringNoThe UUID of the creator of the pipeline to filter by.
target.ref_typestringNoThe type of the reference to filter by.
target.ref_namestringNoThe reference name to filter by.
target.branchstringNoThe name of the branch to filter by.
target.commit.hashstringNoThe revision to filter by.
target.selector.patternstringNoThe pipeline pattern to filter by.
target.selector.typestringNoThe type of pipeline to filter by.
created_onstringNoThe creation date to filter by.
trigger_typestringNoThe trigger type to filter by.
statusstringNoThe pipeline status to filter by.
sortstringNoThe attribute name to sort on.
pageintegerNoThe page number of elements to retrieve.
pagelenintegerNoThe maximum number of results to return.

bitbucket_pipelines_stop_pipeline

Stop a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
pipeline_uuidstringYesThe UUID of the pipeline.

bitbucket_pipelines_update_pipeline_config

Update configuration Parameters:
ParameterTypeRequiredDefaultDescription
workspacestringYesThis can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
repo_slugstringYesThe repository.
enabledbooleanNoWhether Pipelines is enabled for the repository.
repositoryobjectNoThe repository value
typestringYesThe type value