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

    Interface WithReserved_ipItemRequestBuilder

    Builds and executes requests for operations under /v2/reserved_ips/{reserved_ip}

    interface WithReserved_ipItemRequestBuilder {
        get actions(): ActionsRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithReserved_ipGetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithReserved_ipItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    actions

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Accessors

    Methods

    • To delete a reserved IP and remove it from your account, send a DELETE requestto /v2/reserved_ips/$RESERVED_IP_ADDR.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      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 a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithReserved_ipGetResponse>

      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 a reserved IP and remove it from your account, send a DELETE requestto /v2/reserved_ips/$RESERVED_IP_ADDR.A successful request will receive a 204 status code with no body in response.This indicates that the request was processed successfully.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.

      Parameters

      • 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