Get startedSign in

Create service

POST/v1/api/cd/services
Parameters
Responses
ParameterTypeDescription
cluster_idrequiredstring
configurationarrayConfiguration values to template into the service manifests. You must pass the full list of configuration inputs
dry_runbooleanIf true, does not actually apply any changes to the cluster
gitobjectGit reference configuration
helmobjectHelm chart configuration input
kustomizeobjectKustomize configuration input
namerequiredstringDesired name for the service
namespacerequiredstringTarget deployment namespace
protectbooleanIf true, marks the service as protected from accidental changes
renderersarrayCustom renderers for processing service manifests
repository_idstringID of the backing repository for this service
sourcesarrayAdditional source repositories for this service
Response samples
200
{
  "cluster_id": "string",
  "component_status": "string",
  "deleted_at": "string",
  "dry_run": false,
  "errors": [
    {
      "message": "string",
      "source": "string",
      "warning": false
    }
  ],
  "git": {
    "folder": "string",
    "ref": "string"
  },
  "helm": {
    "chart": "string",
    "release": "string",
    "repository_id": "string",
    "url": "string",
    "values": "string",
    "values_files": [
      "string"
    ],
    "version": "string"
  },
  "id": "string",
  "inserted_at": "string",
  "interval": "string",
  "kustomize": {
    "enable_helm": false,
    "path": "string"
  },
  "message": "string",
  "name": "string",
  "namespace": "string",
  "protect": false,
  "renderers": [
    {
      "helm": {
        "ignore_hooks": false,
        "release": "string",
        "values": "string",
        "values_files": [
          "string"
        ]
      },
      "path": "string",
      "type": "auto"
    }
  ],
  "repository_id": "string",
  "sha": "string",
  "sources": [
    {
      "git": {
        "folder": "string",
        "ref": "string"
      },
      "path": "string",
      "repository_id": "string"
    }
  ],
  "status": "stale",
  "templated": false,
  "updated_at": "string"
}