Skip to content
GitmoapAPIBeta
Shipcatalog
POST/groups/{group_id}/catalog/services

Declare a service in a group

create_service
  • catalog:manage
    A token needs the catalog:manage scope: Declare, edit and delete catalog servicesGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

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

  • Quota · services per scope

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

Adds a service to the catalog, declared in this group and bound to one or more repository paths (an external service is not built here and binds none). Maintainers and above on the group may declare one; naming a group as owner needs the same standing on that group, naming a team needs authority over the team, and every bound repository must be one you maintain. The slug must be unique in the organization, and the number of services is capped by the plan.

Parameters

Path
  • group_idGroupId (string · uuid)The declaring group's id

Request body

application/json
  • slugServiceSlug (string)
  • annotationsobjectoptional
  • api_specsarray of ApiSpecRefoptional
    • The ApiSpecRef schema
    • pathRepoPath (string)
    • repository_idRepositoryId (string · uuid)
    • spec_kindApiSpecKindopenapigrpcasyncapiWhich interface-description format a spec is written in.
  • descriptionstring or nulloptional
  • display_namestring or nulloptionalDefaults to the slug.
  • externalbooleanoptional
  • kindServiceKindservicelibrarywebsitejobdatastoreapiml_modelotheroptionalWhat sort of thing a service is. The kind decides which scorecard checks apply: a library has no deployments, so a deployment check is not applicable to it rather than failing. For your own classifications, use annotations.
  • lifecycleServiceLifecycleexperimentalproductiondeprecatedretiredoptionalWhere a service is in its life.
  • linksarray of ServiceLinkoptional
    • The ServiceLink schema
    • link_typeServiceLinkTyperunbookdashboarddocschatotherWhat a service link points at. other covers anything the listed kinds do not.
    • urlHttpsUrl (string)
  • owner_group_idGroupId (string · uuid) or nulloptionalThe group that owns this service. Naming a group here requires Maintainer on that group as well, since it makes that team responsible for the service.
  • owner_principal_idPrincipalId (string · uuid) or nulloptional
  • owner_team_idTeamId (string · uuid) or nulloptionalThe team that owns this service. Naming a team here requires maintaining that team, or managing the organization's teams.
  • providesarray of ProvidedArtifactoptional
    • The ProvidedArtifact schema
    • formatPackageRegistryFormatnpmcargopypiThe package ecosystem a registry speaks. A group has at most one registry per format.
    • namePackageName (string)
  • repo_pathsarray of ServiceRepoPathInputoptional
Request body exampleSynthesized example
{
"slug": "slug-7e09"
}

Responses

201The service was declaredapplication/json
  • created_atstring
  • display_namestring
  • group_idGroupId (string · uuid)The declaring group — where the entry lives for listing and quota purposes. Not necessarily the owner.
  • kindServiceKindservicelibrarywebsitejobdatastoreapiml_modelotherWhat sort of thing a service is. The kind decides which scorecard checks apply: a library has no deployments, so a deployment check is not applicable to it rather than failing. For your own classifications, use annotations.
  • lifecycleServiceLifecycleexperimentalproductiondeprecatedretiredWhere a service is in its life.
  • service_idServiceId (string · uuid)
  • slugServiceSlug (string)
  • sourceServiceSourceinferreddeclaredapiHow the catalog entry came to exist. Set by the platform, never accepted from a request. Any source other than inferred means a person has vouched for the entry.
  • updated_atstring
  • versioninteger · int64The service's revision, incremented on every change. Send it with an update to have the update refused with a 409 if someone changed the service since you read it.
  • annotationsobjectoptional
  • api_specsarray of ApiSpecRefoptional
    • The ApiSpecRef schema
    • pathRepoPath (string)
    • repository_idRepositoryId (string · uuid)
    • spec_kindApiSpecKindopenapigrpcasyncapiWhich interface-description format a spec is written in.
  • created_byActorSummary or nulloptional
  • descriptionstring or nulloptional
  • externalbooleanoptionalWhether the service is built outside gitmoap — a vendor SaaS, a service on another forge, a database provisioned elsewhere. The catalog records its name, owner and the dependencies on it, and nothing else. An external service has no repository paths.
  • linksarray of ServiceLinkoptional
    • The ServiceLink schema
    • link_typeServiceLinkTyperunbookdashboarddocschatotherWhat a service link points at. other covers anything the listed kinds do not.
    • urlHttpsUrl (string)
  • orphaned_atstring or nulloptionalWhen the catalog file declaring this service stopped declaring it. The service is kept, with its history, rather than deleted.
  • ownerOwnerRef or nulloptionalWho owns the service. Absent when nobody does.
  • providesarray of ProvidedArtifactoptional
    • The ProvidedArtifact schema
    • formatPackageRegistryFormatnpmcargopypiThe package ecosystem a registry speaks. A group has at most one registry per format.
    • namePackageName (string)
  • repo_pathsarray of ServiceRepoPathoptional
    • The ServiceRepoPath schema
    • path_globstring
    • path_prefixstringThe longest literal prefix of path_glob, worked out by the platform. Read-only.
    • repository_idRepositoryId (string · uuid)
    • is_excludebooleanoptionalWhether this glob removes its matches from the service's paths instead of adding them. It affects only its own service.
201 exampleSynthesized example
{
"created_at": "2026-10-12T00:38:21Z",
"display_name": "Mara Okafor",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "32bec60f-1092-4110-80e1-98ae8f38a26c",
"slug": "slug-860d",
"source": "inferred",
"updated_at": "2026-10-10T19:47:33Z",
"version": 15,
"annotations": {},
"api_specs": [
{
"path": "path-accd",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"spec_kind": "openapi"
}
],
"created_by": {
"email": "mara@acme.example",
"id": "id-5326",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/73010a9b"
},
"description": "Renders each region as density contours of its operations.",
"external": false,
"links": [
{
"link_type": "runbook",
"url": "https://gitmoap.example/acme/d743fe7e"
}
],
"orphaned_at": "2026-10-15T21:44:47Z",
"owner": {
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "group",
"full_path": "acme/payments-api"
},
"provides": [
{
"format": "npm",
"name": "payments-api"
}
],
"repo_paths": [
{
"path_glob": "path-glob-c3de",
"path_prefix": "path-prefix-4b32",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
}
]
}
400Validation errorapplication/json
Error codes
  • 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-5805",
"message": "Inline scalar newtypes but keep their brand"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/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-8243",
"message": "Stream pipeline status into the run header"
}
}
403Insufficient standing on the group, or on the group named as ownerapplication/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-55ab",
"message": "Draw the region map from operation density"
}
}
404No such group, or a named repository is not visibleapplication/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-f186",
"message": "Pin a page's payload to the build that rendered it"
}
}
409The slug is already taken in this namespaceapplication/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-a411",
"message": "Stream pipeline status into the run header"
}
}
429The namespace is at its service limitapplication/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-3975",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap catalog create-service

  • --group-ididThe declaring group's id (id or group path)
  • --annotationsjsonoptional
  • --api-specsjsonoptional
  • --descriptionstringoptional
  • --display-namestringoptionalDefaults to the slug.
  • --externalflagoptional
  • --kindservice | library | website | job | datastore | api | ml_model | otheroptional
  • --lifecycleexperimental | production | deprecated | retiredoptional
  • --linksjsonoptional
  • --owner-group-idstringoptional
  • --owner-principal-idstringoptional
  • --owner-team-idstringoptional
  • --providesjsonoptional
  • --repo-pathsjsonoptional
  • --slugstring

Used in these guides