Read the organisation's CI settings
import requests
url = "https://platform.ankra.app/api/v1/org/ci-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/ci-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/ci-settings \
--header 'Authorization: Bearer <token>'{
"ci_cluster_id": "<string>",
"ci_cluster_name": "<string>",
"ci_build_fallback": "<string>",
"ci_max_parallel_runs": 123,
"ci_max_parallel_steps": 123,
"ci_allowed_image_prefixes": [
"<string>"
],
"ci_artifact_retention_days": 123,
"ci_cache_retention_days": 123,
"ci_run_retention_days": 123,
"ci_image_gate": "<string>",
"ci_ignore_unfixed": true,
"ci_egress_allowed_cidrs": [
"<string>"
],
"ci_always_run_stages": [
"<string>"
],
"ci_full_run_on_default_branch": true,
"ci_skip_markers": "<string>",
"platform_builds_enabled": true,
"is_default": true,
"updated_at": "2023-11-07T05:31:56Z",
"workspace_sandbox_warning": "<string>"
}Pipelines
Read the organisation's CI settings
The organisation’s Ankra Pipelines settings: the pipeline cluster, build fallback, parallelism, allowed step images, retention, the image gate and path-filter safety nets, and whether Ankra has granted the platform build lane. Readable by any member.
GET
/
api
/
v1
/
org
/
ci-settings
Read the organisation's CI settings
import requests
url = "https://platform.ankra.app/api/v1/org/ci-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/ci-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/ci-settings \
--header 'Authorization: Bearer <token>'{
"ci_cluster_id": "<string>",
"ci_cluster_name": "<string>",
"ci_build_fallback": "<string>",
"ci_max_parallel_runs": 123,
"ci_max_parallel_steps": 123,
"ci_allowed_image_prefixes": [
"<string>"
],
"ci_artifact_retention_days": 123,
"ci_cache_retention_days": 123,
"ci_run_retention_days": 123,
"ci_image_gate": "<string>",
"ci_ignore_unfixed": true,
"ci_egress_allowed_cidrs": [
"<string>"
],
"ci_always_run_stages": [
"<string>"
],
"ci_full_run_on_default_branch": true,
"ci_skip_markers": "<string>",
"platform_builds_enabled": true,
"is_default": true,
"updated_at": "2023-11-07T05:31:56Z",
"workspace_sandbox_warning": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
The CI settings.
The organisation's Ankra Pipelines settings. ci_cluster_id and ci_cluster_name are null when no pipeline cluster is chosen; ci_cluster_name alone is null when the chosen cluster was deleted. is_default reports that every setting is Ankra's default. platform_builds_enabled is Ankra's grant of the platform build lane, not a setting.