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

    Interface Reserved_ipsRequestBuilder

    Builds and executes requests for operations under /v2/reserved_ips

    interface Reserved_ipsRequestBuilder {
        byReserved_ip(reserved_ip: string): WithReserved_ipItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Reserved_ipsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Reserved_ipsGetResponse>;
        post(
            body: Reserved_ip_createMember1 | Reserved_ip_createMember2,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Reserved_ipsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Reserved_ipsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Reserved_ip_createMember1 | Reserved_ip_createMember2,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Reserved_ipsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byReserved_ip get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Reserved_ip_createMember1 | Reserved_ip_createMember2,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Reserved_ipsPostResponse>

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

      Parameters

      • body: Reserved_ip_createMember1 | Reserved_ip_createMember2

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Reserved_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 reserved IP must be either assigned to a Droplet or reserved to a region.* To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute.* To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the region attribute.Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.

      Parameters

      • body: Reserved_ip_createMember1 | Reserved_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