Skip to content
GitmoapAPIBeta
Identity & platformclient-config
GET/.well-known/gitmoap-client-config

The settings the command-line tools read to reach Gitmoap.

get_client_config
  • Public
    This operation declares no security requirement: it takes no token.

The API URL, the git endpoint, the sign-in settings and where client downloads live — what the gitmoap CLI and the git remote helper read so they carry only the service's host. Anyone may read it, without signing in; clients cache it for a day, and a shared cache may hold it for five minutes.

Responses

200The client configurationapplication/json
  • api_urlstringBase URL of the REST API, no trailing slash.
  • cli_client_idstringThe OAuth client id the CLI signs in as.
  • cognito_domainstringThe domain of the hosted sign-in page the login flow authorizes against, without a scheme.
  • cognito_regionstringThe AWS region of the sign-in service.
  • git_endpointstringWebSocket endpoint for git transport (wss://…), used by git-remote-gitmoap.
  • download_basestring or nulloptionalWhere the client binaries are published, no trailing slash. Absent when none are.
200 exampleSynthesized example
{
"api_url": "https://gitmoap.example/acme/63c3b247",
"cli_client_id": "b490e1c4-b0d9-4ad0-92ed-9dcb57c432e0",
"cognito_domain": "cognito-domain-c6cb",
"cognito_region": "cognito-region-e3ad",
"git_endpoint": "git-endpoint-6df4",
"download_base": "download-base-850c"
}
501This deployment does not publish a client configurationapplication/json
Error codes
  • NOT_IMPLEMENTEDThis deployment has not configured the feature the operation needs; 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.
501 exampleSynthesized example
{
"error": {
"code": "code-8ca0",
"message": "Stream pipeline status into the run header"
}
}

CLI

gitmoap client-config get-client-config