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

    Interface HealthRequestBuilder

    Builds and executes requests for operations under /v2/apps/{app_-id}/health

    interface HealthRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | App_health_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): HealthRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • Retrieve information like health status, cpu and memory utilization of app components.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | App_health_response>

      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

    • Retrieve information like health status, cpu and memory utilization of app components.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns HealthRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods