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

    Interface AlertsRequestBuilder

    Builds and executes requests for operations under /v2/monitoring/alerts

    interface AlertsRequestBuilder {
        byAlert_uuid(alert_uuid: string): WithAlert_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AlertsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | AlertsGetResponse>;
        post(
            body: Alert_policy_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | AlertsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AlertsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Alert_policy_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AlertsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAlert_uuid get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.

      Parameters

      Returns Promise<undefined | AlertsGetResponse>

      error when the service returns a 401 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: Alert_policy_request,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | AlertsPostResponse>

      To create a new alert, send a POST request to /v2/monitoring/alerts.

      Parameters

      • body: Alert_policy_request

        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 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 a new alert, send a POST request to /v2/monitoring/alerts.

      Parameters

      • body: Alert_policy_request

        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