Helm Main Calls

Get helm by ID

get/helm/{helmId}

Request

Path parameters

helmIdstring uuid required

Helm ID

Response

Get helm by ID

idstring uuid required
created_atstring date-time required
updated_atstring date-time
namestring required

name is case insensitive

descriptionstring
timeout_secinteger

Maximum number of seconds allowed for helm to run before killing it and mark it as failed

auto_previewboolean required

Indicates if the 'environment preview option' is enabled.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

auto_deployboolean required

Specify if the service will be automatically updated after receiving a new image tag or a new commit according to the source type.

argumentsstring[] required

The extra arguments to pass to helm

allow_cluster_wide_resourcesboolean required

If we should allow the chart to deploy object outside his specified namespace. Setting this flag to true, requires special rights

icon_uristring uri required

Icon URI representing the helm service.

service_type'APPLICATION' | 'DATABASE' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required

type of the service (application, database, job, ...)

Example response

{
  "ports": [
    {
      "internal_port": 8080,
      "external_port": 8080
    }
  ],
  "source": {
    "git": {
      "git_repository": {
        "owner": "John Doe",
        "name": "simple-node-app",
        "deployed_commit_tag": "v1.0.1"
      }
    }
  },
  "values_override": {
    "file": {
      "git": {
        "git_repository": {
          "owner": "John Doe",
          "name": "simple-node-app",
          "deployed_commit_tag": "v1.0.1"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.