Skip to main content
PUT
Update the organisation's CI settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

At least one setting must be named; an absent member keeps its stored value. platform_builds_enabled is Ankra's grant and is refused here.

ci_cluster_id
string<uuid> | null

Cluster pipeline steps run on; null clears the choice.

ci_build_fallback
enum<string>
Available options:
platform_builders,
none
ci_max_parallel_runs
integer
Required range: 1 <= x <= 64
ci_max_parallel_steps
integer
Required range: 1 <= x <= 256
ci_allowed_image_prefixes
string[]
Maximum array length: 50
Maximum string length: 200
ci_artifact_retention_days
integer
Required range: 1 <= x <= 365
ci_cache_retention_days
integer
Required range: 1 <= x <= 365
ci_run_retention_days
integer
Required range: 7 <= x <= 365
ci_image_gate
string

Which image findings block a publish.

ci_ignore_unfixed
boolean
ci_egress_allowed_cidrs
string[]
Maximum array length: 32
ci_always_run_stages
string[]
Maximum array length: 50
Maximum string length: 100
ci_full_run_on_default_branch
boolean
ci_skip_markers
enum<string>
Available options:
everywhere,
except_default_branch,
never

Response

The CI settings after the change.

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.

ci_cluster_id
string | null
required
ci_cluster_name
string | null
required
ci_build_fallback
string
required
ci_max_parallel_runs
integer
required
ci_max_parallel_steps
integer
required
ci_allowed_image_prefixes
string[]
required
ci_artifact_retention_days
integer
required
ci_cache_retention_days
integer
required
ci_run_retention_days
integer
required
ci_image_gate
string
required
ci_ignore_unfixed
boolean
required
ci_egress_allowed_cidrs
string[]
required
ci_always_run_stages
string[]
required
ci_full_run_on_default_branch
boolean
required
ci_skip_markers
string
required
platform_builds_enabled
boolean
required
is_default
boolean
required
updated_at
string<date-time> | null
required
workspace_sandbox_warning
string | null