Skip to content
GitmoapAPIBeta
Integrateprovider-admin
PUT/admin/providers/{provider_id}/featured

Set or clear a provider's featured rank

set_provider_featured
  • provider_admin:manage
    A token needs the provider_admin:manage scope: Review, feature and sunset provider submissionsGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

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

Features a provider in the marketplace at a rank, where a lower rank is placed higher; sending no rank removes the provider from the featured set. A private provider cannot be featured, because featuring places it in front of everyone. Answers with the provider's updated marketplace card. Platform administrators only.

Parameters

Path
  • provider_idProviderId (string)Provider id

Request body

application/json
  • featured_rankinteger · int32 or nulloptional0–∞Where to feature the provider: lower numbers are placed higher. null or absent stops featuring it.
Request body exampleSynthesized example
{}

Responses

200The updated marketplace cardapplication/json
  • categoriesarray of Category: one of source-control | build | test | quality | security | release | deploy | infrastructure | notify | other
  • created_atstring
  • descriptionstring
  • idProviderId (string)
  • keywordsarray of Keyword (string)
  • namestring
  • namespace_verifiedbooleanWhether the provider's publisher has verified its namespace. false for providers gitmoap builds itself, which have no publisher.
  • signedbooleanWhether the latest version's images are signed by gitmoap, as platform and verified providers' are.
  • tierProviderTierplatformverifiedcommunityprivateHow a pipeline provider is distributed and how much it is vouched for.
  • updated_atstring
  • visibilityProviderVisibility
  • featured_rankinteger · int32 or nulloptional0–∞Where gitmoap features the provider: lower numbers are placed higher. Absent when it is not featured.
  • install_countinteger · int64 or nulloptional0–∞How many organizations have installed the provider. Absent for providers gitmoap builds itself.
  • latest_versionProviderVersion (string) or nulloptional
  • lifecycle_stateVersionLifecycleactivedeprecatedsunsetor nulloptionalWhere the latest version is in its life: active, deprecated or sunset.
  • publisher_idPublisherId (string · uuid) or nulloptional
200 exampleSynthesized example
{
"categories": [
"source-control"
],
"created_at": "2026-10-14T10:03:44Z",
"description": "Renders each region as density contours of its operations.",
"id": "id-8f89",
"keywords": [
"keywords-c1e5",
"keywords-6069"
],
"name": "payments-api",
"namespace_verified": false,
"signed": false,
"tier": "platform",
"updated_at": "2026-10-11T12:47:46Z",
"visibility": {
"kind": "public"
},
"featured_rank": 48,
"install_count": 3,
"latest_version": "latest-version-ab89",
"lifecycle_state": "active",
"publisher_id": "bfaa3ac2-2271-4457-8d61-258c8a56de07"
}
400Provider is Private (cannot be featured)application/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-96d1",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-88e5",
"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-2261",
"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-c07a",
"message": "Stream pipeline status into the run header"
}
}
409The request conflicts with the resource's current state; `reason` says howapplication/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-a1e9",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap provider-admin set-provider-featured

  • --provider-ididProvider id
  • --featured-ranknumberoptionalWhere to feature the provider: lower numbers are placed higher. `null` or absent stops featuring it.

Used in these guides