import requests
url = "https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs"
payload = {
"ref": "<string>",
"head_sha": "<string>",
"inputs": {},
"reason": "<string>",
"spec_yaml": "<string>",
"full_run": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ref: '<string>',
head_sha: '<string>',
inputs: {},
reason: '<string>',
spec_yaml: '<string>',
full_run: true
})
};
fetch('https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ref": "<string>",
"head_sha": "<string>",
"inputs": {},
"reason": "<string>",
"spec_yaml": "<string>",
"full_run": true
}
'{
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_number": 123
}Dispatch a pipeline run of a pipeline repository
Queues a manual pipeline run on a ref, optionally pinned to a commit and with dispatch inputs. Needs pipelines.operate; a spec_yaml override also needs pipelines.manage, and event push (standing in for the tracked branch’s push) also needs applications.deploy. The commit’s provenance is checked with the repository’s host before the run is queued.
import requests
url = "https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs"
payload = {
"ref": "<string>",
"head_sha": "<string>",
"inputs": {},
"reason": "<string>",
"spec_yaml": "<string>",
"full_run": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ref: '<string>',
head_sha: '<string>',
inputs: {},
reason: '<string>',
spec_yaml: '<string>',
full_run: true
})
};
fetch('https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ref": "<string>",
"head_sha": "<string>",
"inputs": {},
"reason": "<string>",
"spec_yaml": "<string>",
"full_run": true
}
'{
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_number": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The connected pipeline repository.
Body
A manual pipeline dispatch. Every member is optional; an empty body dispatches the default branch.
The ref to run; the repository's default branch when empty.
Pins the commit; it must be on ref.
Dispatch inputs the definition declares.
Show child attributes
Show child attributes
A one-off pipeline definition override; needs pipelines.manage.
push runs as the tracked branch's push (needs applications.deploy); manual by default.
manual, push Run every stage, ignoring path filters and affected-only analysis.