Documentation menu

Get agent policy

GEThttps://api.instacloud.com/projects/{projectId}/agent-policy

Token scope: account · org · project — read-only tokens allowed.

Parameters

NameInTypeRequiredDescription
projectIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
policyobjectyes
policy.mode"full_access" | "read_only" | "branch_specific" | "customize"yes
policy.protectedBranchIdsstring[]yes
policy.rulesobjectyes
policy.branchDeveloperRulesobjectyes
policy.updatedBystringno
policy.updatedAtstringno
agentSessionEpochintegeryes
actionsstring[]yes
actionCatalogobject[]yes
actionCatalog.actionstringyes
actionCatalog.groupstringyes
actionCatalog.groupLabelstringyes
actionCatalog.labelstringyes
actionCatalog.hintstringyes
actionCatalog.editablebooleanyesfalse when a rule naming this action is refused as a fixed invariant
actionCatalog.fixedDecision"allow" | "deny" | "approve" | null | nullyeswhat a non-editable action resolves to under the restricted modes; null when editable. full_access allows even the denied ones, so this and the current decision disagree for exactly what stops being allowed when full access is left
defaultRulesobjectyes
defaultRules.projectobjectyes
defaultRules.unprotectedBranchobjectyes
defaultRules.protectedBranchobjectyes
effectiveRulesobjectyes
effectiveRules.projectobjectyes
effectiveRules.unprotectedBranchobjectyes
effectiveRules.protectedBranchobjectyes
bootstrapRulesobjectyes
bootstrapRules.project.create"allow"yes
ruleNotesstring[]yes

View as Markdown