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

    Interface WithAlert_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/monitoring/alerts/{alert_uuid}

    interface WithAlert_uuItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAlert_uuGetResponse>;
        put(
            body: Alert_policy_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAlert_uuPutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Alert_policy_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithAlert_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      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 retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithAlert_uuGetResponse>

      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 update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.

      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 | WithAlert_uuPutResponse>

      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 delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.

      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

    Settings

    Member Visibility

    On This Page

    Methods