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

    Interface AlertsRequestBuilder

    Builds and executes requests for operations under /v2/uptime/checks/{check_id}/alerts

    interface AlertsRequestBuilder {
        byAlert_id(alert_id: string): WithAlert_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AlertsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | AlertsGetResponse>;
        post(
            body: AlertsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | AlertsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AlertsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: AlertsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AlertsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAlert_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.

      Parameters

      Returns Promise<undefined | AlertsGetResponse>

      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: AlertsPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | AlertsPostResponse>

      To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributesin the table below in the JSON body.

      Parameters

      • body: AlertsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | AlertsPostResponse>

      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 create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributesin the table below in the JSON body.

      Parameters

      • body: AlertsPostRequestBody

        The request body

      • 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