Skip to content
GitmoapAPIBeta
Integrateprovider-settings
POST/groups/{group_id}/providers/{provider_id}/install

Install a provider into a group at a pinned version.

install_provider
  • provider_settings:manage
    A token needs the provider_settings:manage scope: Install, upgrade and uninstall providersGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

  • Quota · provider installs per scope

    x-gitmoap-quota: {"kind":"enforced","arg":"provider_installs_per_scope"}

Installs a provider into the group at a pinned version — the newest published one when you name none. Installing a provider the group already has replaces the whole install, so anything you leave out returns to its default. A Community or Private provider is refused until you acknowledge that you take responsibility for running it.

Parameters

Path
  • group_idGroupId (string · uuid)Group id
  • provider_idProviderId (string)Provider slug

Request body

application/json
  • acknowledge_unverifiedbooleanoptionalMust be true to install a Community/Private (unverified) provider — the per-install trust acknowledgement. Ignored for Platform/Verified.
  • allowed_versionsVersionPolicy or nulloptionalThe versions a node may declare. Absent ⇒ AnyPublished.
  • override_parentboolean or nulloptional
  • track_latestboolean or nulloptionalOpt this install into tracking the provider's latest published version (unpinned nodes auto-advance). Absent ⇒ pin the resolved version.
  • versionProviderVersion (string) or nulloptionalBecomes the scope's default_version. Defaults to the provider's latest_version when omitted.
Request body exampleSynthesized example
{}

Responses

200application/json
  • allowed_versionsVersionPolicy
  • enabledboolean
  • group_idGroupId (string · uuid)
  • override_parentboolean
  • provider_idProviderId (string)
  • track_latestbooleanWhether this install tracks the provider's latest published version.
  • updated_atstring
  • default_versionProviderVersion (string) or nulloptional
  • installed_atstring or nulloptional
  • installed_byActorSummary or nulloptional
  • trust_acknowledged_atstring or nulloptional
  • trust_acknowledged_byActorSummary or nulloptionalSet when a Community/Private (unverified) provider was installed with the per-install trust acknowledgement.
200 exampleSynthesized example
{
"allowed_versions": {
"kind": "any_published"
},
"enabled": true,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"override_parent": false,
"provider_id": "d8901d64-2cf4-480e-a524-4123fda60c5e",
"track_latest": false,
"updated_at": "2026-10-12T06:01:11Z",
"default_version": "default-version-58ea",
"installed_at": "2026-10-09T03:51:46Z",
"installed_by": {
"email": "tomas@acme.example",
"id": "id-7bf1",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/ff8d9fb0"
},
"trust_acknowledged_at": "2026-10-14T08:32:39Z",
"trust_acknowledged_by": {
"email": "lin@acme.example",
"id": "id-a5e8",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/f8ce1e89"
}
}
400application/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-0960",
"message": "Stream pipeline status into the run header"
}
}
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-2782",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-7c15",
"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-f591",
"message": "Inline scalar newtypes but keep their brand"
}
}
409The provider is already installed in this groupapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • 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.
409 exampleSynthesized example
{
"error": {
"code": "code-fd79",
"message": "Stream pipeline status into the run header"
}
}
429Provider-install limit reached for this groupapplication/json
Error codes
  • TOO_MANY_REQUESTSRetryableA quota, a rate limit or a transfer budget is spent. When the response carries Retry-After, retry after that many seconds
  • 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.
429 exampleSynthesized example
{
"error": {
"code": "code-5bbe",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap provider-settings install-provider

  • --group-ididGroup id (id or group path)
  • --provider-ididProvider slug
  • --acknowledge-unverifiedflagoptionalMust be `true` to install a Community/Private (unverified) provider — the per-install trust acknowledgement. Ignored for Platform/Verified.
  • --allowed-versionsjsonoptional
  • --override-parentflagoptional
  • --track-latestflagoptionalOpt this install into tracking the provider's latest published version (unpinned nodes auto-advance). Absent ⇒ pin the resolved `version`.
  • --versionstringoptional

Used in these guides