Components

Register a component

Changed on

Register a status page component in a project, or refresh an existing active component with the same name. A person with settings write access, where component deregistration is enabled, who registers an inactive component's name reactivates it and reattaches nothing it detached; a secret key registering an inactive name is refused as component_inactive.

post/components

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/components
  • Auth: none declared

Request body

projectIdstring uuid

Project to register the component in. Auto-filled from CLI and SDK context when omitted.

namestring required

Evidence-backed component name to register.

slugstring

Canonical machine identifier for the component, e.g. the deploy or app-directory name (payments-api) or a vendor slug (postgres). Registration also matches an existing component whose name normalises to this slug.

descriptionstring

Optional component description.

requestIdstring uuid

Project-scoped idempotency key. Reuse only for an identical registration request.

origin'code_detected' | 'log_observed'

Machine provenance of this registration: 'code_detected' when the component was inferred from repository or code analysis, 'log_observed' (the default) when inferred from telemetry. Only applies to machine (secret-key) callers; human registrations are always recorded as 'user_declared' and ignore this field.

Response

OK

Changes

  • 26252a3c6d1bRevision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

  • 7a70c84144feRevision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status