CompuDime API docs

Reference / Schemas

Problem

Type: object.

NameTypeDescription
code requiredstring
detail requiredstring
requestId requiredstring
retryable requiredboolean
status requiredinteger
title requiredstring
type requiredstring (uri)A stable identifier of the problem: https://api.compudime.com/docs/errors#<code>, the same on every deployment. Compare it as a string; it is also the code's entry on the errors page, so following it explains the problem.
docsUrlstring (uri)Where this problem code is documented, on the address you call the API on: <API address>/docs/errors#<code>. Present when the deployment knows its address.
integrationIdstringThe integration the API key belongs to. Present once the key has been authenticated: on every problem except a 401 and a 404 or 405 answered before authentication. Quote it with requestId when asking CompuDime for support.
statusUrlstring (uri)The public status page (no key needed): check it before retrying a 5xx. A deployment without a status page names its own readiness report, <public base URL>/readyz. Present when the deployment knows either.
storeIdstringThe store the API key belongs to. Present exactly when integrationId is; never on a 401.
supportstring (uri)Where to ask CompuDime for help, as a mailto: URI: mailto:<support address>. Write there with requestId, and integrationId when the problem has one; never send a key. Present when the deployment has a support address.

No other fields appear.

Used by