kubernetes

Annotate a Kubernetes deployment

Changed on

Add or overwrite annotations on a deployment and on the pods it creates. Annotations the payload does not name are kept. Changing a pod annotation rolls the workload, which is how a rollout restart is triggered. Access policy: Authenticated user.

patch/kubernetes/{id}/namespaces/{namespace}/deployments/{name}

Request

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

Path parameters

idinteger required

Environment(Endpoint) identifier

namespacestring required

Namespace

namestring required

Deployment name

Request body

annotationsobject
podAnnotationsobject

Response

Success

apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

Changes