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

    Interface ChecksRequestBuilder

    Builds and executes requests for operations under /v2/uptime/checks

    interface ChecksRequestBuilder {
        byCheck_id(check_id: string): WithCheck_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                ChecksRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ChecksGetResponse>;
        post(
            body: ChecksPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ChecksPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ChecksRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: ChecksPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ChecksRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byCheck_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.

      Parameters

      Returns Promise<undefined | ChecksGetResponse>

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

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

      Parameters

      • body: ChecksPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ChecksPostResponse>

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

      Parameters

      • body: ChecksPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ChecksRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods