Atlassian · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Atlassian Bitbucket Pipelines API
59 actions
59 updates
phrasing
extends
openapi/atlassian-pipelines-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
What the actions change
x-apievangelist-phrasing
Targets 59 · first 16 shown; the file carries all of them
$.info
$.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].get
$.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].post
$.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].put
$.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].delete
$.paths['/repositories/{workspace}/{repo_slug}/pipelines'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines'].post
$.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].delete
$.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}'].delete
$.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log'].get
$.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Atlassian Bitbucket Pipelines API
version: 1.0.0
extends: openapi/atlassian-pipelines-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 58
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].get
update:
x-apievangelist-phrasing:
intent: List a deployment environment's variables
effect: read
questions:
- Which variables are set on a specific Bitbucket deployment environment like staging?
- Can I see the environment-level variables for one deployment environment in my repo?
instructions:
- text: List the variables on deployment environment {environment_uuid} in {workspace}/{repo_slug}.
slots:
environment_uuid: path.environment_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me every variable defined for deployment environment {environment_uuid}.
slots:
environment_uuid: path.environment_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].post
update:
x-apievangelist-phrasing:
intent: Add a variable to a deployment environment
effect: write
questions:
- How do I add a secret variable to just my production deployment environment?
- Can a deployment environment variable be marked as secured so its value is hidden?
instructions:
- text: Add deployment variable {key} with value {value} to environment {environment_uuid} in {workspace}/{repo_slug}.
slots:
key: requestBody.key
value: requestBody.value
environment_uuid: path.environment_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Create a secured variable {key} on deployment environment {environment_uuid}, secured set to {secured}.
slots:
key: requestBody.key
environment_uuid: path.environment_uuid
secured: requestBody.secured
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].put
update:
x-apievangelist-phrasing:
intent: Change a deployment environment variable
effect: write
questions:
- Can I change the value of an existing variable on a deployment environment?
- What's the way to rotate a value stored on one deployment environment's variable?
instructions:
- text: Update deployment variable {variable_uuid} on environment {environment_uuid} to value {value}.
slots:
variable_uuid: path.variable_uuid
environment_uuid: path.environment_uuid
value: requestBody.value
- text: Rename deployment environment variable {variable_uuid} in {workspace}/{repo_slug} to key {key}.
slots:
variable_uuid: path.variable_uuid
workspace: path.workspace
repo_slug: path.repo_slug
key: requestBody.key
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a deployment environment variable
effect: destructive
questions:
- Can I remove a variable from a single deployment environment without touching the repo variables?
- What happens when I delete a variable from a deployment environment?
instructions:
- text: Delete variable {variable_uuid} from deployment environment {environment_uuid} in {workspace}/{repo_slug}.
slots:
variable_uuid: path.variable_uuid
environment_uuid: path.environment_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Remove the deployment environment variable {variable_uuid} on environment {environment_uuid}.
slots:
variable_uuid: path.variable_uuid
environment_uuid: path.environment_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines'].get
update:
x-apievangelist-phrasing:
intent: List a repository's pipeline runs
effect: read
questions:
- What pipelines have run recently in my Bitbucket repository?
- Can I get a history of all pipeline runs for one repo?
instructions:
- text: List the pipeline runs for {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me every pipeline that has run in repository {repo_slug}.
slots:
repo_slug: path.repo_slug
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines'].post
update:
x-apievangelist-phrasing:
intent: Trigger a new pipeline run
effect: write
questions:
- How do I kick off a Bitbucket pipeline run from the API?
- Can I start a pipeline on a specific branch or commit with custom variables?
- Is it possible to run a custom pipeline manually instead of waiting for a push?
instructions:
- text: Run a pipeline in {workspace}/{repo_slug} against target {target}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
target: requestBody.target
- text: Trigger a pipeline on target {target} with pipeline variables {variables}.
slots:
target: requestBody.target
variables: requestBody.variables
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].get
update:
x-apievangelist-phrasing:
intent: List a repository's pipeline caches
effect: read
questions:
- Which build caches does my repository's pipeline currently have stored?
- Can I see the dependency caches Pipelines has saved for my repo?
instructions:
- text: List the pipeline caches in {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me all stored build caches for this repository.
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].delete
update:
x-apievangelist-phrasing:
intent: Delete all versions of a named cache
effect: destructive
questions:
- Can I clear every version of a cache by its name, like the node cache?
- What's the fastest way to wipe all stored versions of one named pipeline cache?
instructions:
- text: Delete all versions of the pipeline cache named {name} in {workspace}/{repo_slug}.
slots:
name: query.name
workspace: path.workspace
repo_slug: path.repo_slug
- text: Clear every cache version called {name} from this repository.
slots:
name: query.name
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one pipeline cache by ID
effect: destructive
questions:
- Can I delete a single cache entry by its UUID rather than by name?
- Is there a way to remove just one specific cache version from my pipelines?
instructions:
- text: Delete pipeline cache {cache_uuid} from {workspace}/{repo_slug}.
slots:
cache_uuid: path.cache_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Remove the single cache entry {cache_uuid}.
slots:
cache_uuid: path.cache_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri'].get
update:
x-apievangelist-phrasing:
intent: Get a download link for a cache's content
effect: read
questions:
- Where can I download the actual contents of a pipeline cache?
- Can I get a URI to fetch what's stored inside a build cache?
instructions:
- text: Get the content download URI for cache {cache_uuid} in {workspace}/{repo_slug}.
slots:
cache_uuid: path.cache_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Give me the link to download cache {cache_uuid}'s contents.
slots:
cache_uuid: path.cache_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get a single pipeline run
effect: read
questions:
- What's the status and result of one specific pipeline run?
- Can I look up a pipeline by its UUID to see who triggered it and how long it took?
instructions:
- text: Get pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me the state and build time of pipeline {pipeline_uuid}.
slots:
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps'].get
update:
x-apievangelist-phrasing:
intent: List the steps of a pipeline run
effect: read
questions:
- Which steps did a given pipeline run go through?
- Can I see every step and its status inside one pipeline?
instructions:
- text: List the steps of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me all steps for pipeline {pipeline_uuid}.
slots:
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get one step of a pipeline run
effect: read
questions:
- What happened in one particular step of a pipeline run?
- Can I fetch the details of a single pipeline step by its UUID?
instructions:
- text: Get step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show the status of step {step_uuid} in pipeline {pipeline_uuid}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log'].get
update:
x-apievangelist-phrasing:
intent: Download the log for a pipeline step
effect: read
questions:
- Where do I get the full build log for a failed pipeline step?
- Can I fetch just part of a step's log using a byte range?
instructions:
- text: Download the log for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Fetch the build output log of step {step_uuid} in pipeline {pipeline_uuid}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get a build or service container log for a step
effect: read
questions:
- Can I read the log from a service container, like the database, that ran alongside a step?
- Where are the logs for an individual container within a pipeline step?
instructions:
- text: Get container log {log_uuid} for step {step_uuid} of pipeline {pipeline_uuid}.
slots:
log_uuid: path.log_uuid
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
- text: Fetch the service container log {log_uuid} from step {step_uuid} in pipeline {pipeline_uuid} of {workspace}/{repo_slug}.
slots:
log_uuid: path.log_uuid
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports'].get
update:
x-apievangelist-phrasing:
intent: Summarize test results for a pipeline step
effect: read
questions:
- How many tests passed or failed in a given pipeline step?
- Can I get a test report summary for one step of my pipeline?
instructions:
- text: Summarize the test reports for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Give me the pass/fail test summary for step {step_uuid} in pipeline {pipeline_uuid}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases'].get
update:
x-apievangelist-phrasing:
intent: List test cases run in a pipeline step
effect: read
questions:
- Which individual test cases ran in a particular pipeline step?
- Can I list every test case result from one step of a build?
instructions:
- text: List the test cases for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show each test case that ran in step {step_uuid} of pipeline {pipeline_uuid}.
slots:
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons'].get
update:
x-apievangelist-phrasing:
intent: Get failure output for a test case
effect: read
questions:
- Why did a specific test case fail in my pipeline step?
- Can I see the failure reason output for one test case?
instructions:
- text: Get the failure reasons for test case {test_case_uuid} in step {step_uuid} of pipeline {pipeline_uuid}.
slots:
test_case_uuid: path.test_case_uuid
step_uuid: path.step_uuid
pipeline_uuid: path.pipeline_uuid
- text: Show the output explaining test case {test_case_uuid} in {workspace}/{repo_slug} pipeline {pipeline_uuid}, step {step_uuid}.
slots:
test_case_uuid: path.test_case_uuid
workspace: path.workspace
repo_slug: path.repo_slug
pipeline_uuid: path.pipeline_uuid
step_uuid: path.step_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline'].post
update:
x-apievangelist-phrasing:
intent: Stop a running pipeline
effect: destructive
questions:
- Can I cancel a pipeline that's still running?
- What happens to steps that haven't finished when I stop a pipeline?
instructions:
- text: Stop pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
slots:
pipeline_uuid: path.pipeline_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Halt the running pipeline {pipeline_uuid} and all its unfinished steps.
slots:
pipeline_uuid: path.pipeline_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config'].get
update:
x-apievangelist-phrasing:
intent: Check whether Pipelines is enabled on a repo
effect: read
questions:
- Is Bitbucket Pipelines turned on for my repository?
- Where can I view a repository's pipelines configuration?
instructions:
- text: Get the pipelines configuration for {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Check whether Pipelines is enabled in repository {repo_slug}.
slots:
repo_slug: path.repo_slug
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config'].put
update:
x-apievangelist-phrasing:
intent: Enable or disable Pipelines for a repo
effect: write
questions:
- Can I switch Pipelines on or off for a repository through the API?
- What setting do I change to disable builds for a repo?
instructions:
- text: Set Pipelines enabled to {enabled} for {workspace}/{repo_slug}.
slots:
enabled: requestBody.enabled
workspace: path.workspace
repo_slug: path.repo_slug
- text: Turn on Pipelines for repository {repo_slug} in {workspace}.
slots:
repo_slug: path.repo_slug
workspace: path.workspace
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/build_number'].put
update:
x-apievangelist-phrasing:
intent: Set the next pipeline build number
effect: write
questions:
- Can I bump the build number so the next pipeline starts from a higher value?
- Why does setting the next build number require a value higher than the latest one?
instructions:
- text: Set the next build number for {workspace}/{repo_slug} to {next}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
next: requestBody.next
- text: Make the next pipeline in this repo use build number {next}.
slots:
next: requestBody.next
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules'].get
update:
x-apievangelist-phrasing:
intent: List a repository's pipeline schedules
effect: read
questions:
- Which scheduled pipeline runs are configured for my repository?
- Can I see all the cron schedules set up for builds?
instructions:
- text: List the pipeline schedules in {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me every configured build schedule for this repo.
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules'].post
update:
x-apievangelist-phrasing:
intent: Schedule a recurring pipeline
effect: write
questions:
- How do I run a pipeline nightly on a cron schedule?
- Can I schedule a pipeline to run on a specific branch at regular intervals?
instructions:
- text: Create a pipeline schedule in {workspace}/{repo_slug} for target {target} with cron {cron_pattern}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
target: requestBody.target
cron_pattern: requestBody.cron_pattern
- text: Schedule target {target} to build on cron pattern {cron_pattern}.
slots:
target: requestBody.target
cron_pattern: requestBody.cron_pattern
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get one pipeline schedule
effect: read
questions:
- What are the details of a particular pipeline schedule?
- Can I check whether a specific schedule is enabled and what it runs?
instructions:
- text: Get pipeline schedule {schedule_uuid} in {workspace}/{repo_slug}.
slots:
schedule_uuid: path.schedule_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me the settings of schedule {schedule_uuid}.
slots:
schedule_uuid: path.schedule_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].put
update:
x-apievangelist-phrasing:
intent: Pause or resume a pipeline schedule
effect: write
questions:
- Can I temporarily pause a scheduled pipeline without deleting it?
- What can I change on an existing pipeline schedule?
instructions:
- text: Set schedule {schedule_uuid} in {workspace}/{repo_slug} to enabled {enabled}.
slots:
schedule_uuid: path.schedule_uuid
workspace: path.workspace
repo_slug: path.repo_slug
enabled: requestBody.enabled
- text: Pause pipeline schedule {schedule_uuid}.
slots:
schedule_uuid: path.schedule_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a pipeline schedule
effect: destructive
questions:
- Can I permanently remove a scheduled pipeline?
- Will deleting a schedule stop all future automatic runs from it?
instructions:
- text: Delete pipeline schedule {schedule_uuid} from {workspace}/{repo_slug}.
slots:
schedule_uuid: path.schedule_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Remove schedule {schedule_uuid} for good.
slots:
schedule_uuid: path.schedule_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions'].get
update:
x-apievangelist-phrasing:
intent: List the runs triggered by a schedule
effect: read
questions:
- Which pipeline runs were started by a given schedule?
- Can I see the execution history of one scheduled pipeline?
instructions:
- text: List the executions of schedule {schedule_uuid} in {workspace}/{repo_slug}.
slots:
schedule_uuid: path.schedule_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show past runs triggered by schedule {schedule_uuid}.
slots:
schedule_uuid: path.schedule_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].get
update:
x-apievangelist-phrasing:
intent: View a repo's pipeline SSH public key
effect: read
questions:
- What SSH public key do my pipelines use to connect to other servers?
- Can I retrieve the pipeline SSH key pair without exposing the private key?
instructions:
- text: Get the pipelines SSH public key for {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me the SSH key pair configured for this repository's pipelines.
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].put
update:
x-apievangelist-phrasing:
intent: Set the pipeline SSH key pair
effect: write
questions:
- How do I give my build container an SSH identity to deploy to a server?
- Can I upload my own private and public SSH key for pipelines to use?
instructions:
- text: Set the pipelines SSH key pair for {workspace}/{repo_slug} with public key {public_key} and private key {private_key}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
public_key: requestBody.public_key
private_key: requestBody.private_key
- text: Replace the repository's pipeline SSH identity with private key {private_key}.
slots:
private_key: requestBody.private_key
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].delete
update:
x-apievangelist-phrasing:
intent: Remove the pipeline SSH key pair
effect: destructive
questions:
- Can I delete the SSH key pair my pipelines use?
- What's the way to revoke the build container's SSH identity for a repo?
instructions:
- text: Delete the pipelines SSH key pair from {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Remove this repository's pipeline SSH keys.
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts'].get
update:
x-apievangelist-phrasing:
intent: List pipeline SSH known hosts
effect: read
questions:
- Which hosts are trusted as SSH known hosts for my repository's pipelines?
- Can I see the known_hosts entries Pipelines uses for this repo?
instructions:
- text: List the pipeline known hosts for {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show all trusted SSH known hosts for this repository.
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts'].post
update:
x-apievangelist-phrasing:
intent: Trust a new SSH known host for pipelines
effect: write
questions:
- How do I add a server to my pipeline's known hosts so SSH doesn't prompt?
- Can I register a host's public key as trusted for builds?
instructions:
- text: Add known host {hostname} with public key {public_key} to {workspace}/{repo_slug} pipelines.
slots:
hostname: requestBody.hostname
public_key: requestBody.public_key
workspace: path.workspace
repo_slug: path.repo_slug
- text: Trust SSH host {hostname} for this repository's pipelines.
slots:
hostname: requestBody.hostname
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get one pipeline known host
effect: read
questions:
- What fingerprint is stored for a particular known host?
- Can I look up a single trusted host entry by its UUID?
instructions:
- text: Get known host {known_host_uuid} in {workspace}/{repo_slug}.
slots:
known_host_uuid: path.known_host_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show the stored public key for known host {known_host_uuid}.
slots:
known_host_uuid: path.known_host_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}'].put
update:
x-apievangelist-phrasing:
intent: Update a pipeline known host
effect: write
questions:
- Can I update the public key of a known host after the server's key changed?
- Is it possible to change the hostname on an existing known host entry?
instructions:
- text: Update known host {known_host_uuid} in {workspace}/{repo_slug} to public key {public_key}.
slots:
known_host_uuid: path.known_host_uuid
workspace: path.workspace
repo_slug: path.repo_slug
public_key: requestBody.public_key
- text: Change known host {known_host_uuid}'s hostname to {hostname}.
slots:
known_host_uuid: path.known_host_uuid
hostname: requestBody.hostname
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a pipeline known host
effect: destructive
questions:
- Can I stop trusting a host I previously added to known hosts?
- What's involved in deleting a known host entry from pipelines?
instructions:
- text: Delete known host {known_host_uuid} from {workspace}/{repo_slug}.
slots:
known_host_uuid: path.known_host_uuid
workspace: path.workspace
repo_slug: path.repo_slug
- text: Untrust known host {known_host_uuid}.
slots:
known_host_uuid: path.known_host_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/variables'].get
update:
x-apievangelist-phrasing:
intent: List repository pipeline variables
effect: read
questions:
- Which repository-level variables are available to my pipelines?
- Can I see all the build variables defined on one repo?
instructions:
- text: List the repository pipeline variables for {workspace}/{repo_slug}.
slots:
workspace: path.workspace
repo_slug: path.repo_slug
- text: Show me every repo-level variable in {repo_slug}.
slots:
repo_slug: path.repo_slug
method: generated
generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/variables'].post
update:
x-apievangelist-phrasing:
intent: Add a repository pipeline variable
effect: write
questions:
- How do I store an API token as a repository variable for all my builds?
- Can repository variables be secured so they're masked in logs?
instructions:
- text: Create repository variable {key} with value {value} in {workspace}/{repo_slug}.
slots:
key: requestBody.key
value: requestBody.value
workspace: path.workspace
repo_slug: path.repo_slug
- text: Add a repo-level pipeline variable {key}, secured {secured}.
slots:
key: requestBody.key
secured: requestBody.secured
method: generated
generated: '2026-10-01'
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/overlays/atlassian-pipelines-api-phrasing-overlay.yaml