Skip to main content
ZStack
Infrastructure/Lifecycle

RegisterComponent

Register a new lifecycle-managed component with the control plane

POST/api/v1/lifecycle/components

Operation ID

RegisterComponent

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    StringRequired

    Human-readable name for the component being registered

    Example: zcf-core

  • category
    StringRequired

    Component category

    Example: zcf

  • version
    StringRequired

    Version of the component being registered

    Example: 1.2.0

  • release
    StringRequired

    Release of the component being registered

    Example: 221

  • endpoint
    StringRequired

    Network endpoint where the component is reachable

    Example: https://zcf-core.svc.cluster.local:8080

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the component

    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • name
    String

    Human-readable name of the component

    Example: zcf-core

  • category
    String

    Component category

    Example: zcf

  • capabilities
    String

    Capabilities for this resource

    Example: value

  • createDate
    String

    Create date

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Last op date

    Example: 2026-01-15T08:00:00Z