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

    Interface AlertsRequestBuilder

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

    interface AlertsRequestBuilder {
        byAlert_id(alert_id: string): WithAlert_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Apps_list_alerts_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AlertsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAlert_id get toGetRequestInformation withUrl

    Methods

    • List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Apps_list_alerts_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

    • List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns AlertsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods