Skip to content
GitmoapAPIBeta
Shipcatalog
GET/groups/{group_id}/catalog/deployments

The deployment board — services × environments

list_group_deployments
  • catalog:read
    A token needs the catalog:read scope: Read the service catalog: services, their bindings, their owners and their overviewsGranted by read_api, write_api.Every operation this scope unlocks
  • Filtered across resources

    x-gitmoap-isolation: {"kind":"cross_resource_filtered"}

  • Paginated
    Pass the next_token a page returns to get the next one.

Lists the group's services, alphabetically, each with its current deployment in every environment the group can deploy to, its own and those inherited from groups above it. Environments owned by a group you cannot see are left out. Every other environment is a column on every page, up to 500; a board that would show more is refused, so narrow the environments with environment_id or tier. Narrow the services with search; pages hold up to 100 services (20 by default). Commits-behind counts are not included here; ask the drift endpoint for them.

Parameters

Path
  • group_idGroupId (string · uuid)The group whose services the board lists
Query
  • environment_idstringoptionalShow only these environments, as a comma-separated list of ids
  • tierstringoptionalShow only environments of this tier
  • searchstringoptionalMatch a service's name, description or slug substring
  • limitinteger · int32optionalServices per page (1-100, default 20)
  • next_tokenstringoptionalPagination cursor

Responses

200The board: the environments shown, and one entry per service with its deployment in eachapplication/json
  • environmentsarray of EnvironmentSummary
    • The EnvironmentSummary schema
    • archivedboolean
    • environment_idEnvironmentId (string · uuid)
    • scopeScopeRef
    • slugEnvironmentSlug (string)
    • tierEnvironmentTierdevelopmenttestingstagingproductionWhat kind of environment this is, whatever it is called: development, testing, staging or production. A production environment is protected by default.
    • display_namestring or nulloptional
    • urlstring or nulloptional
  • rowsarray of DeploymentBoardRow
    • The DeploymentBoardRow schema
    • cellsarray of DeploymentBoardCell
      • The DeploymentBoardCell schema
      • environment_idEnvironmentId (string · uuid)
      • commits_behindinteger · int32 or nulloptional0–∞How many commits the deployment is behind its repository's default branch. Only present when the request asks for it.
      • deploymentDeploymentSummary or nulloptional
    • serviceServiceSummary
      • The ServiceSummary schema
      • display_namestring
      • group_idGroupId (string · uuid)
      • 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.
      • externalbooleanoptional
      • orphaned_atstring or nulloptional
      • ownerOwnerRef or nulloptional
  • next_tokenstring or nulloptional
200 exampleSynthesized example
{
"environments": [
{
"archived": false,
"environment_id": "67d0ae80-abd0-4683-b9a5-e72df373f835",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"slug": "slug-2e03",
"tier": "development"
}
],
"rows": [
{
"cells": [],
"service": {
"display_name": "Lin Park",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "3f1c6792-268e-490c-8182-63abb4b2583b",
"slug": "slug-2b0a",
"source": "inferred"
}
},
{
"cells": [],
"service": {
"display_name": "Lin Park",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "9f7960fa-6c30-4491-8ece-b497f17b08ce",
"slug": "slug-f4d0",
"source": "inferred"
}
}
],
"next_token": "next-token-b1ad"
}
400Unknown filter value, malformed cursor, or more than 500 environment columnsapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • VALIDATION_ERRORA value is outside what the operation accepts; the message says which
  • 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-c67c",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-3405",
"message": "Draw the region map from operation density"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/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-f40a",
"message": "Stream pipeline status into the run header"
}
}
404No such group, or it is not visible to the callerapplication/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-a46a",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap catalog list-group-deployments

  • --group-ididThe group whose services the board lists (id or group path)
  • --environment-idstringoptionalShow only these environments, as a comma-separated list of ids
  • --limitnumberoptionalServices per page (1-100, default 20)
  • --next-tokenstringoptionalPagination cursor
  • --searchstringoptionalMatch a service's name, description or slug substring
  • --tierstringoptionalShow only environments of this tier

Used in these guides