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

    Interface Reserved_ipv6RequestBuilder

    Builds and executes requests for operations under /v2/reserved_ipv6

    interface Reserved_ipv6RequestBuilder {
        byReserved_ipv6(
            reserved_ipv6: string,
        ): WithReserved_ipv6ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Reserved_ipv6RequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Reserved_ipv6GetResponse>;
        post(
            body: Reserved_ipv6_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Reserved_ipv6PostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Reserved_ipv6RequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Reserved_ipv6_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Reserved_ipv6RequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post

    • post(
          body: Reserved_ipv6_create,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Reserved_ipv6PostResponse>

      On creation, a reserved IPv6 must be reserved to a region.* To create a new reserved IPv6 reserved to a region, send a POST request to /v2/reserved_ipv6 with the region_slug attribute.

      Parameters

      • body: Reserved_ipv6_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Reserved_ipv6PostResponse>

      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 IPv6 must be reserved to a region.* To create a new reserved IPv6 reserved to a region, send a POST request to /v2/reserved_ipv6 with the region_slug attribute.

      Parameters

      • body: Reserved_ipv6_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation