@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface UpgradeRequestBuilder

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/upgrade

    interface UpgradeRequestBuilder {
        post(
            body: UpgradePostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toPostRequestInformation(
            body: UpgradePostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): UpgradeRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: UpgradePostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To immediately upgrade a Kubernetes cluster to a newer patch release ofKubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade.The body of the request must specify a version attribute.Available upgrade versions for a cluster can be fetched from/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.

      Parameters

      • body: UpgradePostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To immediately upgrade a Kubernetes cluster to a newer patch release ofKubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade.The body of the request must specify a version attribute.Available upgrade versions for a cluster can be fetched from/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.

      Parameters

      • body: UpgradePostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns UpgradeRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods