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

    Interface WithCheck_ItemRequestBuilder

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

    interface WithCheck_ItemRequestBuilder {
        get alerts(): AlertsRequestBuilder;
        get state(): StateRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCheck_GetResponse>;
        put(
            body: WithCheck_PutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCheck_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: WithCheck_PutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithCheck_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    alerts state

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 statuscode with no body will be returned in response to a successful request.Deleting a check will also delete alerts associated with the check.

      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 show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCheck_GetResponse>

      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 the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.

      Parameters

      • body: WithCheck_PutRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCheck_PutResponse>

      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 Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 statuscode with no body will be returned in response to a successful request.Deleting a check will also delete alerts associated with the check.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.

      Parameters

      • body: WithCheck_PutRequestBody

        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

    Accessors
    Methods