Jump to

• Request
• Response

Get the Current Value Settings for a Helm Chart

get

/api/microservice/Deploy

Gets the current value settings for a Helm chart by Helm release name and version. You set values for installed Helm charts using the POST method on the /api/microservice/Deploy endpoint. Manually installing Helm charts with the a1helm binary will not preserve the value settings.

Request

Query Parameters

• Helmchart(required): string
  The name of the Helm chart package.

  Example:

  example-poller

• Namespace(required): string
  Logical grouping of resources within a cluster.

  Example:

  kube-system

• ReleaseName(required): string
  - Release name for the installed Helm chart. - 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`

  Example:

  example-poller-deploy

• Version(required): string
  The version of the Helm chart.

  Example:

  6.0.3

• cluster(required): string
  The name of the cluster.

  Example:

  cluster-1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  The values for the specified Helm chart.
• message: string
  The response message in text.

  Example:
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message in text.",
            "type":"string",
            "example":""
        },
        "data":{
            "description":"The values for the specified Helm chart.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/microserviceDeployRead"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

The values for the specified Helm chart.

Show Source

• Array of: object microserviceDeployRead

{
    "description":"The values for the specified Helm chart.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/microserviceDeployRead"
    }
}

Nested Schema : microserviceDeployRead

Type: object

Show Source

• cluster(required): string
  cluster Name

  Example: cluster-1
• CustomValues: string
  Custom Values

  Example: # Default values for example-poller/n/nglobal:/n imageRegistry: replicaCount: 1/n/nimage:/n
• Helmchart(required): string
  The name of the Helm chart package

  Example: example-poller
• Namespace(required): string
  Logical grouping of resources within a cluster

  Example: kube-system
• ReleaseName(required): string
  - Release name for the installed Helm chart. - 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`

  Example: example-poller-deploy
• Version(required): string
  Version of Helm chart

  Example: 6.0.3

{
    "properties":{
        "cluster":{
            "description":"cluster Name",
            "type":"string",
            "example":"cluster-1"
        },
        "CustomValues":{
            "description":"Custom Values",
            "type":"string",
            "example":"# Default values for example-poller/n/nglobal:/n  imageRegistry: replicaCount: 1/n/nimage:/n"
        },
        "Helmchart":{
            "description":"The name of the Helm chart package",
            "type":"string",
            "example":"example-poller"
        },
        "Namespace":{
            "description":"Logical grouping of resources within a cluster",
            "type":"string",
            "example":"kube-system"
        },
        "ReleaseName":{
            "description":"- Release name for the installed Helm chart. \n- 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`",
            "type":"string",
            "example":"example-poller-deploy"
        },
        "Version":{
            "description":"Version of Helm chart",
            "type":"string",
            "example":"6.0.3"
        }
    },
    "required":[
        "cluster",
        "Namespace",
        "Helmchart",
        "Version",
        "ReleaseName"
    ],
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top