helm

Rollback a helm release

Rollback a helm release to a previous revision Access policy: authenticated

post/endpoints/{id}/kubernetes/helm/{release}/rollback

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/endpoints/{id}/kubernetes/helm/{release}/rollback
  • Auth
    API key in header X-API-KEY and API key in header Authorization

Path parameters

idinteger required

Environment(Endpoint) identifier

releasestring required

Helm release name

Query parameters

namespacestring

specify an optional namespace

revisioninteger

specify the revision to rollback to (defaults to previous revision if not specified)

waitboolean

wait for resources to be ready (default: false)

waitForJobsboolean

wait for jobs to complete before marking the release as successful (default: false)

recreateboolean

performs pods restart for the resource if applicable (default: true)

forceboolean

force resource update through delete/recreate if needed (default: false)

timeoutinteger

time to wait for any individual Kubernetes operation in seconds (default: 300)

Response

Success

appVersionstring

AppVersion is the app version of the release.

configobject

Config is the set of extra Values added to the chart. These values override the default values inside of the chart.

manifeststring

Manifest is the string representation of the rendered template.

namestring

Name is the name of the release

namespacestring

Namespace is the kubernetes namespace of the release.

stackIDinteger

StackID is the ID of the Portainer stack associated with this release (if using GitOps)

versioninteger

Version is an int which represents the revision of the release.

Changes

No recorded changes to this operation across all 21 revisions of this API.