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

    Interface ClusterlintRequestBuilder

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

    interface ClusterlintRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                ClusterlintRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Clusterlint_results>;
        post(
            body: Clusterlint_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ClusterlintPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ClusterlintRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Clusterlint_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ClusterlintRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To request clusterlint diagnostics for your cluster, send a GET request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id queryparameter is provided, then the diagnostics for the specific run is fetched.By default, the latest results are shown.To find out how to address clusterlint feedback, please refer tothe clusterlint check documentation.

      Parameters

      Returns Promise<undefined | Clusterlint_results>

      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

    post

    • post(
          body: Clusterlint_request,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ClusterlintPostResponse>

      Clusterlint helps operators conform to Kubernetes best practices aroundresources, security and reliability to avoid common problems while operatingor upgrading the clusters.To request a clusterlint run on your cluster, send a POST request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. This will run allchecks present in the doks group by default, if a request body is notspecified. Optionally specify the below attributes.For information about the available checks, please refer tothe clusterlint check documentation.

      Parameters

      • body: Clusterlint_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ClusterlintPostResponse>

      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

    • Clusterlint helps operators conform to Kubernetes best practices aroundresources, security and reliability to avoid common problems while operatingor upgrading the clusters.To request a clusterlint run on your cluster, send a POST request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. This will run allchecks present in the doks group by default, if a request body is notspecified. Optionally specify the below attributes.For information about the available checks, please refer tothe clusterlint check documentation.

      Parameters

      • body: Clusterlint_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods