service

Changed on
put/v1/api/cd/services/{id}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/api/cd/services/{id}
  • Auth: none declared

Path parameters

idstring required

Request body

dry_runboolean

If true, does not actually apply any changes to the cluster

namestring required

Desired name for the service

namespacestring required

Target deployment namespace

protectboolean

If true, marks the service as protected from accidental changes

repository_idstring

ID of the backing repository for this service

Response

no description

cluster_idstring

ID of the cluster this service is deployed to

component_statusstring

Status message from components (e.g. unhealthy reason)

deleted_atstring date-time

Timestamp the service was marked for deletion, if deleted

dry_runboolean

If true, this service is running in dry-run mode

idstring

Unique identifier for the service deployment

inserted_atstring date-time
intervalstring

Polling interval for the service reconcile loop (e.g., "5m")

messagestring

Latest commit message from the synced revision

namestring

Name of the service

namespacestring

Kubernetes namespace where the service is deployed

protectboolean

If true, prevents service deletion or config edits

repository_idstring

ID of the git or Helm repository backing this service

shastring

Git commit SHA for the current synced revision. This will be a helm digest if a pure helm chart as well

status'stale' | 'synced' | 'healthy' | 'failed' | 'paused'

Current status of the service deployment (e.g., stale, synced, healthy, failed, paused)

templatedboolean

If true, the service was deployed using a template

updated_atstring date-time

Changes

  • b70919d87a08Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status