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

    Interface ActionsRequestBuilder

    Builds and executes requests for operations under /v2/floating_ips/{floating_ip}/actions

    interface ActionsRequestBuilder {
        byAction_id(action_id: number): WithAction_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ActionsGetResponse>;
        post(
            body: Floating_ip_action_assign | Floating_ip_action_unassign,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ActionsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Floating_ip_action_assign | Floating_ip_action_unassign,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ActionsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAction_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ActionsGetResponse>

      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

    post

    • post(
          body: Floating_ip_action_assign | Floating_ip_action_unassign,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ActionsPostResponse>

      To initiate an action on a floating IP send a POST request to/v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request,set the type attribute to on of the supported action types:| Action | Details|------------|--------| assign | Assigns a floating IP to a Droplet| unassign | Unassign a floating IP from a Droplet

      Parameters

      • body: Floating_ip_action_assign | Floating_ip_action_unassign

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ActionsPostResponse>

      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 retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To initiate an action on a floating IP send a POST request to/v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request,set the type attribute to on of the supported action types:| Action | Details|------------|--------| assign | Assigns a floating IP to a Droplet| unassign | Unassign a floating IP from a Droplet

      Parameters

      • body: Floating_ip_action_assign | Floating_ip_action_unassign

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ActionsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods