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

    Interface Byoip_prefixesRequestBuilder

    Builds and executes requests for operations under /v2/byoip_prefixes

    interface Byoip_prefixesRequestBuilder {
        byByoip_prefix_uuid(
            byoip_prefix_uuid: string,
        ): WithByoip_prefix_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Byoip_prefixesRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Byoip_prefixesGetResponse>;
        post(
            body: Byoip_prefix_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Byoip_prefixesPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Byoip_prefixesRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Byoip_prefix_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Byoip_prefixesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byByoip_prefix_uuid get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

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

      To create a BYOIP prefix, send a POST request to /v2/byoip_prefixes.A successful request will initiate the process of bringing your BYOIP Prefix into your account.The response will include the details of the created prefix, including its UUID and status.

      Parameters

      • body: Byoip_prefix_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Byoip_prefixesPostResponse>

      error when the service returns a 401 status code

      error when the service returns a 422 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 a BYOIP prefix, send a POST request to /v2/byoip_prefixes.A successful request will initiate the process of bringing your BYOIP Prefix into your account.The response will include the details of the created prefix, including its UUID and status.

      Parameters

      • body: Byoip_prefix_create

        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