portainer/portainer-mcp

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

API Key

Password

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Username

Container identifier

Environment identifier

Refresh will force a refresh of the image status cache

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

serviceList screen

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A list of cluster role bindings to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A list of cluster roles to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of Cron Jobs to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of Jobs to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The CustomResourceDefinition name of the custom resource, e.g. 'clusters.postgresql.cnpg.io'

Environment identifier

The name of the custom resource, e.g. 'pg-cluster'

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The name of the Custom Resource Definition to delete.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Ingress details

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The CustomResourceDefinition name of the custom resource, e.g. 'clusters.postgresql.cnpg.io'

Environment identifier

The name of the custom resource, e.g. 'pg-cluster'

The namespace name to delete the custom resource from

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

List of PVCs to delete (namespace + name)

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

List of PV names to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Pod name

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of services to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

List of StorageClass names to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of role bindings to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of roles to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

A map where the key is the namespace and the value is an array of service accounts to delete

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Resource kind

Resource name

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Container identifier

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Include image usage information

Raw request body string (e.g. JSON for POST)

Portainer environment ID

Extra request headers

HTTP method

Docker API path with leading slash, e.g. /containers/json

Query parameters

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Name of the node to drain

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stack identifier

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Azure application ID. Required if environment(endpoint) type is set to 3

Azure authentication key. Required if environment(endpoint) type is set to 3

Azure tenant ID. Required if environment(endpoint) type is set to 3

Container engine used by the environment(endpoint). Value must be one of: 'docker' or 'podman'

KaaS: custom template content to deploy on environment creation

KaaS: custom template identifier to deploy on environment creation

Enable async mode for edge agent

The check in interval for edge agent (in seconds)

The command interval for edge agent (in seconds)

The ping interval for edge agent (in seconds)

The snapshot interval for edge agent (in seconds)

URL or IP address that will be used to establish a reverse tunnel. Required when settings.EnableEdgeComputeFeatures is set to false or when settings.Edge.TunnelServerAddress is not set

Environment(Endpoint) type. Value must be one of: 1 (Local Docker environment), 2 (Agent environment), 3 (Azure environment), 4 (Edge agent environment) or 5 (Local Kubernetes Environment)

List of GPUs - json stringified array of {name, value} structs

Environment(Endpoint) group identifier. If not specified will default to 1 (unassigned).

Kubernetes configuration file content (base64 encoded). Required when EndpointCreationType is set to 6 (KubeConfigEnvironment)

Name that will be used to identify this environment(endpoint) (example: my-environment)

URL or IP address where exposed containers will be reachable. Defaults to URL if not specified (example: docker.mydomain.tld:2375)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

KaaS: stack name for the custom template deployment

JSON-parsable array of tag identifiers to which this environment(endpoint) is associated

Require TLS to connect against this environment(endpoint). Must be true if EndpointCreationType is set to 2 (Agent environment)

TLS CA certificate file

TLS client certificate file

TLS client key file

Skip client verification when using TLS. Must be true if EndpointCreationType is set to 2 (Agent environment)

Skip server verification when using TLS. Must be true if EndpointCreationType is set to 2 (Agent environment)

URL or IP address of a Docker host (example: docker.mydomain.tld:2375). Defaults to local if not specified (Linux: /var/run/docker.sock, Windows: //./pipe/docker_engine). Cannot be empty if EndpointCreationType is set to 4 (Edge agent environment)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The file to upload

Environment(Endpoint) identifier

The destination path to upload the file to

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional volume identifier to upload the file

endpoint ID

registry ID

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

endpoint identifier

PullImage if true will pull the image

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

ServiceId to update

if true, the snapshot data won't be retrieved

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

will return only environments with on of these agent versions

if exists true show only edge async agents, false show only standard edge agents. if missing, will show both types (relevant only for edge agents)

if bigger then zero, show only edge agents that checked-in in the last provided seconds (relevant only for edge agents)

if true, show only untrusted edge agents, if false show only trusted edge agents (relevant only for edge agents)

List environments(endpoints) of these edge groups

will return the environments of the specified edge stack

only applied when edgeStackId exists. Filter the returned environments based on their deployment status in the stack (not the environment status!)

will return only these environments(endpoints)

Exclude environments(endpoints) of these edge groups

Exclude environments of these groups

will exclude these environments(endpoints)

if true, the snapshot data won't be retrieved

List environments(endpoints) of these groups

If true, an X-K8S-Env-Admin header will be added to the response to indicate if the user is a K8S environment admin for any of the returned environments

Limit results to this value

will return only environments(endpoints) with this name

Filter environments by partial name match (case-insensitive, searches name only)

Order sorted results by desc/asc

If true, return only environments with an outdated agent

Filter environments by platform type

If true, will apply policy data to the returned environments(endpoints)

List environments(endpoints) associated with these policies

Filter environments by policy status (applied, failed, in_progress, warning, not_supported). Only applies when policyIds is specified.

If true, will return environment(endpoint) that were provisioned

Search query

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Sort results by this value

Start searching from

List environments(endpoints) by this status

search environments(endpoints) with these tags (depends on tagsPartialMatch)

If true, will return environment(endpoint) which has one of tagIds, if false (or missing) will return only environments(endpoints) that has all the tags

List environments(endpoints) of this type

If true, an X-Update-Available header will be added to the response to indicate if an update is available

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

required if kubernetes environment, will show registries by namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Registry identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Whether GitOps update time restrictions are enabled

Hide manual deployment forms for an environment

Environment(Endpoint) identifier

Security settings updates

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Azure application ID

Azure authentication key

Azure tenant ID

Whether GitOps update time restrictions are enabled

Hide manual deployment forms for an environment

The check in interval for edge agent (in seconds)

GPUs information

Group identifier

Environment(Endpoint) identifier

Associated Kubernetes data

Name that will be used to identify this environment(endpoint)

URL or IP address where exposed containers will be reachable. Defaults to URL if not specified

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The status of the environment(endpoint) (1 - up, 2 - down)

List of tag identifiers to which this environment(endpoint) is associated

Require TLS to connect against this environment(endpoint)

Skip client verification when using TLS

Skip server verification when using TLS

URL or IP address of a Docker host

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Application name

The namespace

The resource type to get the application for

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Namespace name

Node name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Lookup services associated with each ingress

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Set to true to include information about applications that use the ConfigMaps in the response

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The resource id of the involved kubernetes object

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Only return allowed ingress controllers

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

When set to True, include the applications that are using the volumes. It is set to false by default

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Node name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The CustomResourceDefinition name of the custom resource, e.g. 'clusters.postgresql.cnpg.io'

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The CustomResourceDefinition name of the custom resource, e.g. 'clusters.postgresql.cnpg.io'

The format of the custom resource, e.g. 'yaml' or 'json'

Environment identifier

The name of the custom resource, e.g. 'pg-cluster'

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The configmap name to get details for

Environment identifier

The namespace name where the configmap is located

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The name of the Custom Resource Definition to get.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment (Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The namespace name the events are associated to

The resource id of the involved kubernetes object

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Ingress name

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Whether to include Jobs that have a cronjob owner

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Node identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Pod identifier

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The namespace name to get details for

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

When set to true, include the resource quota information as part of the Namespace information. Default is false

The CustomResourceDefinition name of the custom resource, e.g. 'clusters.postgresql.cnpg.io'

The format of the custom resource, e.g. 'yaml' or 'json'

Environment identifier

The name of the custom resource, e.g. 'pg-cluster'

The namespace name to get details for

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

When set to true, include the resource quota information as part of the Namespace information. Default is false

When set to true, include the unhealthy events information as part of the Namespace information. Default is false

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

PersistentVolume name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

PVC name

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

The namespace name where the secret is located

The secret name to get details for

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

When set to true, associate the Secrets with the applications that use them

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Service account name

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Lookup applications associated with each service

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

StorageClass name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Volume name

Environment identifier

Namespace identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

When set to True, include the applications that are using the volumes. It is set to false by default

Deprecated: use SourceID instead

CreatedFromCustomTemplateID will fetch auth from this custom template's git settings

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID resolves URL and auth from the stored source record

StackID will fetch auth from this stack's git settings (edge stack if FromEdgeStack is true)

Path to file whose content will be read

TLSSkipVerify skips SSL verification when cloning the Git repository Deprecated: use SourceID instead

Deprecated: use SourceID instead

Deprecated: use SourceID instead

CreatedFromCustomTemplateID will fetch auth from this custom template's git settings

DirOnly List directories only

list the results without using cache

Allow to provide specific file extension as the search result. If empty, the file extensions yml,yaml,hcl,json will be set by default

Partial or completed file name. If empty, all filenames with included extensions will be returned

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Specific Git repository reference. If empty, the reference ref/heads/main will be set by default

Deprecated: use SourceID instead

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID resolves URL and auth from the stored source record

StackID will fetch auth from this stack's git settings (edge stack if FromEdgeStack is true)

TLSSkipVerify skips SSL verification when cloning the Git repository Deprecated: use SourceID instead

Deprecated: use SourceID instead

Deprecated: use SourceID instead

CreatedFromCustomTemplateID will fetch auth from this custom template's git settings

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID resolves URL and auth from the stored source record

StackID will fetch auth from this stack's git settings (edge stack if FromEdgeStack is true)

TLSSkipVerify skips SSL verification when cloning the Git repository Deprecated: use SourceID instead

Deprecated: use SourceID instead

ValuesFiles is an array of paths to Helm values files (matches Stack.HelmValuesFiles)

Deprecated: use SourceID instead

CreatedFromCustomTemplateID will fetch auth from this custom template's git settings

list the results without using cache

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Deprecated: use SourceID instead

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID resolves URL and auth from the stored source record

StackID will fetch auth from this stack's git settings (edge stack if FromEdgeStack is true)

TLSSkipVerify skips SSL verification when cloning the Git repository Deprecated: use SourceID instead

Deprecated: use SourceID instead

Source identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Source identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Pagination limit (0 = unlimited)

Sort order: asc or desc

Search term (matches URL)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Sort field: name | status | type

Pagination start index

Filter by status: healthy | syncing | error | paused | unknown

Filter by source type: git | oci | helm

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Source identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Source identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Source identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Filter by environment IDs (e.g. endpointIds[]=1&endpointIds[]=2)

Pagination limit (0 = unlimited)

Sort order: asc or desc

Filter by platform: dockerStandalone | dockerSwarm | kubernetes

Search term (matches name or repository URL)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Sort field: name | type | status | platform | creationDate | lastSyncDate

Pagination start index

Filter by status: healthy | syncing | error | paused | unknown

Filter by type: stack | edgeStack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

An optional namespace

The name of the release/application to uninstall

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

specify an optional namespace

Helm release name

specify an optional revision

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

show resources of the release

Environment(Endpoint) identifier

specify an optional namespace

Helm release name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID resolves URL and auth from the stored Source record. When set, the inline Repository/auth/tls fields are ignored.

Dry run

Environment(Endpoint) identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

specify an optional filter

Environment(Endpoint) identifier

specify an optional namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

specify an optional selector

Helm chart name

Helm registry ID (required if repo not provided)

Helm repository URL (required if registryId not provided)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

If true will use cache to search

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

Environment(Endpoint) identifier

specify an optional namespace

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

Helm release name

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

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

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

wait for resources to be ready (default: false)

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

Chart name

chart/values/readme

Environment ID (required if registryId is provided and user is not an admin)

Helm registry ID (required if repo not provided)

Helm repository URL (required if registryId not provided)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Chart version

User identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

User identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

User identifier

Repository identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Toggle the system state of this namespace to true or false

Raw request body string (e.g. JSON manifest for POST)

Portainer environment ID

Extra request headers

HTTP method

Kubernetes API path with leading slash

Query parameters (labelSelector, fieldSelector, ...)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Namespace identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

deployment, statefulset or daemonset

name of the application

The namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment(Endpoint) identifier

Pod name

Namespace

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Refresh will force a refresh of the image status cache

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Service identifier

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

StorageClass name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth

Whether to enable automatic patches

A list of label name & value that will be used to hide containers when querying containers

The content in plaintext used to display in the login page. Will hide when value is empty string

Whether to disable kubeconfig download for non-admin users

Whether to disable kube roles sync for all built-in roles

Whether to disable kubeshell access for non-admin users

The default check in interval for edge agent (in seconds)

EdgePortainerURL is the URL that is exposed to edge agents

Whether edge compute features are enabled

EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone

ForceSecureCookies forces the Secure attribute on auth cookies regardless of the detected scheme

Deployment options for encouraging deployment as code

Helm repository URL

The expiry of a Kubeconfig

Kubectl Shell Image Name/Tag

URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

The interval in which environment(endpoint) snapshots are created

URL to the templates that will be displayed in the UI when navigating to App Templates

TrustOnFirstConnect makes Portainer accepting edge agent connection by default

The duration of a user session

Container identifier

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Edge stack identifier, will return only containers for this edge stack

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Stack identifier

Indicates whether the stack is orphaned

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Swarm identifier

Stack identifier

Namespace for the Kubernetes stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Target format: "kubernetes" for manifests or "helm" for helm chart

Identifier of the environment that will be used to deploy the stack

Environment variables passed during deployment, represented as a JSON array [{'name': 'name', 'value': 'value'}].

Stack file

Name of the stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Applicable when deploying with multiple stack files

Optional GitOps update configuration

Path to the Stack file inside the Git repository

Identifier of the environment that will be used to deploy the stack

A list of environment variables used during stack deployment

Local filesystem path

Whether the stack is from a app template

Name of the stack

List of Registries to use for this stack

Deprecated: use SourceID instead. Use basic authentication to clone the Git repository.

Deprecated: use SourceID instead. RepositoryAuthorizationType is the authorization type to use.

Deprecated: use SourceID instead. Password used in basic authentication. Required when RepositoryAuthentication is true

Deprecated: use SourceID instead. RepositoryProvider is the provider to use.

Reference name of a Git repository hosting the Stack file

Deprecated: use SourceID instead. URL of a Git repository hosting the Stack file.

Deprecated: use SourceID instead. Username used in basic authentication. Required when RepositoryAuthentication is true

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID references an existing Source for git credentials/URL. When set, the inline URL and authentication fields are ignored.

Whether the stack supports relative path volume

Deprecated: use SourceID instead. TLSSkipVerify skips SSL verification when cloning the Git repository.

Identifier of the environment that will be used to deploy the stack

A list of environment variables used during stack deployment

Whether the stack is from a app template

Name of the stack

List of Registries to use for this stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Content of the Stack file

A UUID to identify a webhook. The stack will be force updated and pull the latest image when the webhook was invoked.

Identifier of the environment that will be used to deploy the stack

Environment variables passed during deployment, represented as a JSON array [{'name': 'name', 'value': 'value'}]. Optional

Stack file

Name of the stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Swarm cluster identifier.

Applicable when deploying with multiple stack files

Optional GitOps update configuration

Path to the Stack file inside the Git repository

Identifier of the environment that will be used to deploy the stack

A list of environment variables used during stack deployment

Network filesystem path

Whether the stack is from a app template

Name of the stack

List of Registries to use for this stack

Deprecated: use SourceID instead. Use basic authentication to clone the Git repository.

Deprecated: use SourceID instead. RepositoryAuthorizationType is the authorization type to use.

Deprecated: use SourceID instead. Password used in basic authentication. Required when RepositoryAuthentication is true

Deprecated: use SourceID instead. RepositoryProvider is the provider to use.

Reference name of a Git repository hosting the Stack file

Deprecated: use SourceID instead. URL of a Git repository hosting the Stack file.

Deprecated: use SourceID instead. Username used in basic authentication. Required when RepositoryAuthentication is true

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID references an existing Source for git credentials/URL. When set, the inline URL and authentication fields are ignored.

Whether the stack suppors relative path volume

Swarm cluster identifier

Deprecated: use SourceID instead. TLSSkipVerify skips SSL verification when cloning the Git repository.

Identifier of the environment that will be used to deploy the stack

A list of environment variables used during stack deployment

Whether the stack is from a app template

Name of the stack

List of Registries to use for this stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Content of the Stack file

Swarm cluster identifier

A UUID to identify a webhook. The stack will be force updated and pull the latest image when the webhook was invoked.

Identifier of the environment that will be used to deploy the stack

Whether the stack is from a app template

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Identifier of the environment that will be used to deploy the stack

Helm-specific fields

Array of paths to values YAML files in Git repo

Deprecated: use SourceID instead. Use authentication to clone the Git repository.

Deprecated: use SourceID instead. Authorization type used to clone the Git repository.

Deprecated: use SourceID instead. Password used in authentication.

Deprecated: use SourceID instead. Provider used to clone the Git repository.

Deprecated: use SourceID instead. Reference name of a Git repository hosting the Stack file.

Deprecated: use SourceID instead. URL of a Git repository hosting the Stack file.

Deprecated: use SourceID instead. Username used in authentication.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID references an existing Source for git credentials/URL. When set, the inline URL and authentication fields are ignored.

Deprecated: use SourceID instead. TLSSkipVerify skips SSL verification when cloning the Git repository.

Identifier of the environment that will be used to deploy the stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Set to true to delete an external stack. Only external Swarm stacks are supported

Stack identifier

Set to true to delete named volumes declared in the stack file and anonymous volumes attached to containers. Only affects Docker Standalone stacks.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Set to true to delete an external stack. Only external Swarm stacks are supported

Stack name

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Git repository commit hash. If both version and commitHash are provided, the commitHash will be used

Stack identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stack file version maintained by Portainer. If both version and commitHash are provided, the commitHash will be used

Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack.

Stack identifier

Deprecated(2.36): use RepullImageAndRedeploy instead for cleaner responsibility Force a pulling to current image with the original tag though the image is already the latest

RepullImageAndRedeploy indicates whether to force repulling images and redeploying the stack

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stack identifier

Refresh will force a refresh of the image status cache

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stack identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Filters to process on the stack list. Encoded as JSON (a map[string]string). For example, {'SwarmID': 'jpofkc0i9uo9wtx1zesuk649w'} will only return stacks that are part of the specified Swarm cluster. Available filters: EndpointID, SwarmID.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack.

Stack identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Identifier of the environment(endpoint) that will be used to filter the stacks to clear the image status cache for

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Identifier of the swarm cluster that will be used to filter the stacks to clear the image status cache for

Environment identifier

Stack identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Environment identifier

Stack identifier

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Stack identifier

Environment identifier

A list of environment(endpoint) variables used during stack deployment

Stack identifier

Prune services that are no longer referenced (only available for Swarm stacks)

Deprecated(2.36): use RepullImageAndRedeploy instead for cleaner responsibility Force a pulling to current image with the original tag though the image is already the latest

List of Registries to use for this stack

RepullImageAndRedeploy indicates whether to force repulling images and redeploying the stack

RollbackTo specifies the stack file version to rollback to (only support to rollback to the last version currently)

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

New content of the Stack file

A UUID to identify a webhook. The stack will be force updated and pull the latest image when the webhook was invoked.

Enable atomic rollback on failure (Helm --atomic flag)

Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack.

Helm chart folder path in Git repo (for Helm stacks)

Helm values files paths in Git repo (for Helm stacks)

Stack identifier

Deprecated: use SourceID instead. Use basic authentication to clone the Git repository.

Deprecated: use SourceID instead. Authorization type for git authentication.

Deprecated: use SourceID instead. Password used in basic authentication.

Deprecated: use SourceID instead. Git provider for OAuth-based authentication.

Deprecated: use SourceID instead. URL of a Git repository hosting the Stack file.

Deprecated: use SourceID instead. Username used in basic authentication.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

SourceID references an existing Source for git credentials/URL. When set, the inline URL and authentication fields are ignored.

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).

Optional JMESPath expression to project the response server-side. Use it on noisy endpoints to drop fields you don't need — e.g. [].{id:Id,name:Name,type:Type} for a list of environments, or {kind:Kind,name:metadata.name,phase:status.phase} for a single K8s object. Omit to receive the full response (subject to the global size cap).