Skip to main content
Get Actions enablement and defaults for a repository

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

repository_id
string
required

Stable GitHub repository ID bound to this workspace; owner/name is not an identifier.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$

Response

Workspace-owned settings and safe default state.

repository_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
exists
boolean
required

False only when no settings record exists; omit If-Match for its first write. True means If-Match is required.

enabled
boolean
required
policy_id
string | null
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
state
enum<string>
required
Available options:
disabled,
preparing,
ready,
attention_required
default_label
string
required

The repository's selected BoxRouter runner label.

Required string length: 1 - 128
revision
integer
required
Required range: x >= 1
updated_at
string<date-time>
required
resolved_profile
enum<string>
read-only

Effective software profile resolved by GET from the saved repository policy, or linux-basic when no policy is selected. With exists=false this is the default, not a saved configuration. This does not claim image or route readiness. May be absent on older servers and write or idempotent replay responses; GET is authoritative. It does not change the settings CAS token.

Available options:
linux-basic,
full
reason_code
string | null

Optional machine-readable reason for a non-ready repository state.

Maximum string length: 128
Pattern: ^[a-z][a-z0-9_.-]{0,127}$
message
string | null

Optional plain-language explanation of the current repository state.

Required string length: 1 - 512

Optional destination when the repository state can be fixed in another page.

Available options:
byok,
credits,
null