Skip to main content
API Explorer|API Explorer
Infrastructure/Lifecycle
POSTLifecycleSince 1.0SynchronousAuth Required

RegisterComponent

Register a new lifecycle-managed component with the control plane

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable name for the component being registered

    Example: zcf-core

  • categoryStringRequired

    Component category

    Example: zcf

  • versionStringRequired

    Version of the component being registered

    Example: 1.2.0

  • releaseStringRequired

    Release of the component being registered

    Example: 221

  • endpointStringRequired

    Network endpoint where the component is reachable

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

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the component

    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • nameString

    Human-readable name of the component

    Example: zcf-core

  • categoryString

    Component category

    Example: zcf

  • capabilitiesString

    Capabilities for this resource

    Example: value

  • createDateString

    Create date

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

  • lastOpDateString

    Last op date

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

Endpoint

POST/api/v1/lifecycle/components

/api/v1/lifecycle/components

Operation ID

RegisterComponent

Permalink

Request Example

curl -X POST '{host}/api/v1/lifecycle/components' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"zcf-core","category":"zcf","version":"1.2.0","release":"221","endpoint":"https://zcf-core.svc.cluster.local:8080","capabilities":"value"}'

Response Example

200
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "zcf-core",
  "category": "zcf",
  "capabilities": "example"
}

Change History

This API has no change history records yet.

View all change history