Updates the app env

Updates the app env

Path Parameters

workspace stringrequired

Workspace to use

name stringrequired

The name of the app env you wish or update

Query Parameters

dryRun string

Set to 'All' to perform a server-side dry run of updating this resource

force string

Set to 'true' to override read-only (has no effect unless used by Wayfinder admin)

owner string

Use an explicit owner for this resource - this must match the owner used on create, if set

apply string

Use server-side apply for this update instead of overwriting the whole object

application/json

Request Body required

The specification for the app env you are updating

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
resourceVersion string
selfLink string
uid string
spec
AppEnvSpec defines an environment for an application
application stringrequired
cloud stringrequired
clusterRef
ClusterRef defines the cluster on which this application environment should be hosted. Either ClusterPlan or ClusterRef must be specified. If unspecified, the reference to the created cluster will be set by Wayfinder.
group stringrequired
kind stringrequired
name stringrequired
namespace stringrequired
version stringrequired
key string
name stringrequired
namespace stringrequired
order int32
plan string
region string
stage stringrequired
status
AppEnvStatus defines the status of an application environment
certIssuers string[]
cloudResourcesCreated boolean
clusterDomain string
conditions undefined[]
detail string
lastTransitionTime stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
deployment
Deployment shows the deployed status of the app to this environment. The deployment status will be updated approximately once per minute, to get up to date status, call the deploystatus subresource API of the appenv.
components undefined[]
Components describes the status of the deployed components
certReady boolean
cloudResource
CloudResource identifies the status of the cloud resource associated with this component, when the component type is CloudResource.
moduleVersion string
plan string
ready boolean
component stringrequired
componentType stringrequired
deployed boolean
endpoint string
exposed boolean
pods undefined[]
Pods gives a detailed status for each pod for this component in the environment.
conditions undefined[]
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
lastProbeTime string
lastTransitionTime string
message string
reason string
status stringrequired
type stringrequired
containerStatuses undefined[]
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
containerID string
image stringrequired
imageID stringrequired
lastState
Details about the container's last termination condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32required
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
name stringrequired
ready booleanrequired
restartCount int32required
started boolean
state
Details about the container's current condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32required
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
initContainerStatuses undefined[]
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
containerID string
image stringrequired
imageID stringrequired
lastState
Details about the container's last termination condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32required
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
name stringrequired
ready booleanrequired
restartCount int32required
started boolean
state
Details about the container's current condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32required
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
message string
phase string
reason string
podsReady int32
podsTotal int32
tls boolean
deployed boolean
deploymentLastChecked string
detail string
dnsZone string
dnsZoneDedicated boolean
ingressClasses undefined[]
IngressClasses are the ingress classes which can be used in the app env
class stringrequired
namespace string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
obsoleteResources undefined[]
kind stringrequired
name stringrequired
status stringrequired
wayfinderVersion string

Responses

200

Contains the app env definition

application/json

Schema

Schema

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion string
blockOwnerDeletion boolean
controller boolean
kind string
name string
uid string
resourceVersion string
selfLink string
uid string
spec
AppEnvSpec defines an environment for an application
application string
cloud string
clusterRef
ClusterRef defines the cluster on which this application environment should be hosted. Either ClusterPlan or ClusterRef must be specified. If unspecified, the reference to the created cluster will be set by Wayfinder.
group string
kind string
name string
namespace string
version string
key string
name string
namespace string
order int32
plan string
region string
stage string
status
AppEnvStatus defines the status of an application environment
certIssuers string[]
cloudResourcesCreated boolean
clusterDomain string
conditions undefined[]
detail string
lastTransitionTime string
message string
name string
negativePolarity boolean
observedGeneration int64
reason string
status string
type string
deployment
Deployment shows the deployed status of the app to this environment. The deployment status will be updated approximately once per minute, to get up to date status, call the deploystatus subresource API of the appenv.
components undefined[]
Components describes the status of the deployed components
certReady boolean
cloudResource
CloudResource identifies the status of the cloud resource associated with this component, when the component type is CloudResource.
moduleVersion string
plan string
ready boolean
component string
componentType string
deployed boolean
endpoint string
exposed boolean
pods undefined[]
Pods gives a detailed status for each pod for this component in the environment.
conditions undefined[]
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
lastProbeTime string
lastTransitionTime string
message string
reason string
status string
type string
containerStatuses undefined[]
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
containerID string
image string
imageID string
lastState
Details about the container's last termination condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
name string
ready boolean
restartCount int32
started boolean
state
Details about the container's current condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
initContainerStatuses undefined[]
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
containerID string
image string
imageID string
lastState
Details about the container's last termination condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
name string
ready boolean
restartCount int32
started boolean
state
Details about the container's current condition.
running
Details about a running container
startedAt string
terminated
Details about a terminated container
containerID string
exitCode int32
finishedAt string
message string
reason string
signal int32
startedAt string
waiting
Details about a waiting container
message string
reason string
message string
phase string
reason string
podsReady int32
podsTotal int32
tls boolean
deployed boolean
deploymentLastChecked string
detail string
dnsZone string
dnsZoneDedicated boolean
ingressClasses undefined[]
IngressClasses are the ingress classes which can be used in the app env
class string
namespace string
lastReconcile
generation int64
time string
lastSuccess
generation int64
time string
message string
obsoleteResources undefined[]
kind string
name string
status string
wayfinderVersion string

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
      "string"
    ],
    "generateName": "string",
    "generation": 0,
    "labels": {},
    "managedFields": [
      {
        "apiVersion": "string",
        "fieldsType": "string",
        "fieldsV1": "string",
        "manager": "string",
        "operation": "string",
        "subresource": "string",
        "time": "string"
      }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
      {
        "apiVersion": "string",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "application": "string",
    "cloud": "string",
    "clusterRef": {
      "group": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "version": "string"
    },
    "key": "string",
    "name": "string",
    "namespace": "string",
    "order": 0,
    "plan": "string",
    "region": "string",
    "stage": "string"
  },
  "status": {
    "certIssuers": [
      "string"
    ],
    "cloudResourcesCreated": true,
    "clusterDomain": "string",
    "conditions": [
      {
        "detail": "string",
        "lastTransitionTime": "string",
        "message": "string",
        "name": "string",
        "negativePolarity": true,
        "observedGeneration": 0,
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "deployment": {
      "components": [
        {
          "certReady": true,
          "cloudResource": {
            "moduleVersion": "string",
            "plan": "string",
            "ready": true
          },
          "component": "string",
          "componentType": "string",
          "deployed": true,
          "endpoint": "string",
          "exposed": true,
          "pods": [
            {
              "conditions": [
                {
                  "lastProbeTime": "string",
                  "lastTransitionTime": "string",
                  "message": "string",
                  "reason": "string",
                  "status": "string",
                  "type": "string"
                }
              ],
              "containerStatuses": [
                {
                  "containerID": "string",
                  "image": "string",
                  "imageID": "string",
                  "lastState": {
                    "running": {
                      "startedAt": "string"
                    },
                    "terminated": {
                      "containerID": "string",
                      "exitCode": 0,
                      "finishedAt": "string",
                      "message": "string",
                      "reason": "string",
                      "signal": 0,
                      "startedAt": "string"
                    },
                    "waiting": {
                      "message": "string",
                      "reason": "string"
                    }
                  },
                  "name": "string",
                  "ready": true,
                  "restartCount": 0,
                  "started": true,
                  "state": {
                    "running": {
                      "startedAt": "string"
                    },
                    "terminated": {
                      "containerID": "string",
                      "exitCode": 0,
                      "finishedAt": "string",
                      "message": "string",
                      "reason": "string",
                      "signal": 0,
                      "startedAt": "string"
                    },
                    "waiting": {
                      "message": "string",
                      "reason": "string"
                    }
                  }
                }
              ],
              "initContainerStatuses": [
                {
                  "containerID": "string",
                  "image": "string",
                  "imageID": "string",
                  "lastState": {
                    "running": {
                      "startedAt": "string"
                    },
                    "terminated": {
                      "containerID": "string",
                      "exitCode": 0,
                      "finishedAt": "string",
                      "message": "string",
                      "reason": "string",
                      "signal": 0,
                      "startedAt": "string"
                    },
                    "waiting": {
                      "message": "string",
                      "reason": "string"
                    }
                  },
                  "name": "string",
                  "ready": true,
                  "restartCount": 0,
                  "started": true,
                  "state": {
                    "running": {
                      "startedAt": "string"
                    },
                    "terminated": {
                      "containerID": "string",
                      "exitCode": 0,
                      "finishedAt": "string",
                      "message": "string",
                      "reason": "string",
                      "signal": 0,
                      "startedAt": "string"
                    },
                    "waiting": {
                      "message": "string",
                      "reason": "string"
                    }
                  }
                }
              ],
              "message": "string",
              "phase": "string",
              "reason": "string"
            }
          ],
          "podsReady": 0,
          "podsTotal": 0,
          "tls": true
        }
      ],
      "deployed": true
    },
    "deploymentLastChecked": "string",
    "detail": "string",
    "dnsZone": "string",
    "dnsZoneDedicated": true,
    "ingressClasses": [
      {
        "class": "string",
        "namespace": "string"
      }
    ],
    "lastReconcile": {
      "generation": 0,
      "time": "string"
    },
    "lastSuccess": {
      "generation": 0,
      "time": "string"
    },
    "message": "string",
    "obsoleteResources": [
      {
        "kind": "string",
        "name": "string"
      }
    ],
    "status": "string",
    "wayfinderVersion": "string"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...