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

    Interface Floating_ipsRequestBuilder

    Builds and executes requests for operations under /v2/floating_ips

    interface Floating_ipsRequestBuilder {
        byFloating_ip(floating_ip: string): WithFloating_ipItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Floating_ipsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Floating_ipsGetResponse>;
        post(
            body: Floating_ip_createMember1 | Floating_ip_createMember2,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Floating_ipsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Floating_ipsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Floating_ip_createMember1 | Floating_ip_createMember2,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Floating_ipsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byFloating_ip get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Floating_ip_createMember1 | Floating_ip_createMember2,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Floating_ipsPostResponse>

      On creation, a floating IP must be either assigned to a Droplet or reserved to a region.* To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute.* To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute.Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.

      Parameters

      • body: Floating_ip_createMember1 | Floating_ip_createMember2

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Floating_ipsPostResponse>

      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

    • On creation, a floating IP must be either assigned to a Droplet or reserved to a region.* To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute.* To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute.Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.

      Parameters

      • body: Floating_ip_createMember1 | Floating_ip_createMember2

        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