Lifecycle API overview

Lifecycle’s supported integration surface is the authenticated v2 API at this path on your deployment:

Use the API reference that the deployment generates:

• /v2/docs — interactive API documentation
• /api/docs — OpenAPI document

These documents contain the methods and schemas for the running release.

Authenticate

Programmatic routes accept a Lifecycle API key when its scopes and repository constraint authorize the operation:

Administrator and personal-settings routes can accept only an OIDC browser session. An API key cannot access these routes. Examine the operation’s security declaration in the generated reference. See API authentication.

Read responses

v2 success responses use a standard envelope:

List responses can also include metadata.pagination. Errors keep data null and contain a stable machine-readable error.code:

Log request_id with your integration’s own operation ID. Branch on HTTP status and error.code, not the human-readable message.

Design a reliable caller

• Use page and limit only as documented for that list operation.
• Read the pagination metadata in the response.
• Honor Retry-After after a 429 response.
• Retry transient failures with bounded exponential backoff.
• Do not retry validation or authorization failures without changing the request or credential.
• Send an idempotencyKey when you create an API Environment.
• Use the same key again with the same caller and request to replay the existing Environment.
• A different request with the same key returns a conflict.
• Do not log bearer credentials, request bodies containing secret values, or one-time API-key creation responses.

Only Environment creation supports idempotency. Treat a different write route as idempotent only if the generated reference says so.

Typical task guides

• Create and manage API Environments
• Create and scope API keys
• Manage sites
• Add build metadata links