Skip to content
GitmoapAPIBeta
Integrateprovider-settings
GET/repositories/{repo_id}/provider-policy

Get the provider tier policy in effect for a repository

get_repo_provider_policy

The policy the repository's pipeline runs are checked against when they start, resolved from its group and the groups above it. Each setting comes from the nearest group, this one or one above it, that sets it, and the defaults fill the rest; the response names the group it came from, whether it is inherited, and which tiers are accepted. Anyone who can see the repository; on a public repository that includes callers who are not signed in.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository id

Responses

200application/json
  • accept_communityCommunityAcceptancedisabledanyverified_onlyWhether an organization's pipelines may run Community-tier providers. disabled (the default) refuses them; any admits any Community provider in the catalog; verified_only admits only those whose publisher namespace is verified.
  • accept_own_privateboolean
  • accept_verifiedboolean
  • accepted_tiersarray of ProviderTier: one of platform | verified | community | privateThe provider tiers this policy accepts in some form. platform is always included.
  • inheritedboolean
  • override_parentboolean
  • require_changelog_ackbooleanWhen set, moving to a newer provider version requires acknowledging its changelog first. Off by default.
  • scope_idstringThe id of the group or repository asked about.
  • source_scope_idstring or nulloptionalThe id of the group or repository whose policy supplied these values — possibly a group above the one asked about. Absent when no policy is set anywhere and the defaults apply.
  • updated_byActorSummary or nulloptionalWho last changed the policy that supplied these values. Absent when no policy is set anywhere and the defaults apply.
200 exampleSynthesized example
{
"accept_community": "disabled",
"accept_own_private": false,
"accept_verified": false,
"accepted_tiers": [
"platform",
"platform"
],
"inherited": false,
"override_parent": false,
"require_changelog_ack": false,
"scope_id": "66b309a1-e593-424c-b84b-1f28db8d1c94",
"source_scope_id": "a41d32a2-cdcf-44b1-bd20-b32f71d734ed",
"updated_by": {
"email": "mara@acme.example",
"id": "id-c954",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/93e09caf"
}
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-b4fc",
"message": "Draw the region map from operation density"
}
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-bda1",
"message": "Label every synthesized example"
}
}
403application/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-d7a2",
"message": "Draw the region map from operation density"
}
}
404application/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-c812",
"message": "Stream pipeline status into the run header"
}
}

CLI

gitmoap provider-settings get-repo-provider-policy

  • --repo-ididRepository id (id or owner/repo path)

Used in these guides