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

    Interface ActionsRequestBuilder

    Builds and executes requests for operations under /v2/volumes/actions

    interface ActionsRequestBuilder {
        post(
            body: Volume_action_post_attach | Volume_action_post_detach,
            requestConfiguration?: RequestConfiguration<
                ActionsRequestBuilderPostQueryParameters,
            >,
        ): Promise<undefined | ActionsPostResponse>;
        toPostRequestInformation(
            body: Volume_action_post_attach | Volume_action_post_detach,
            requestConfiguration?: RequestConfiguration<
                ActionsRequestBuilderPostQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): ActionsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Volume_action_post_attach | Volume_action_post_detach,
          requestConfiguration?: RequestConfiguration<
              ActionsRequestBuilderPostQueryParameters,
          >,
      ): Promise<undefined | ActionsPostResponse>

      To initiate an action on a block storage volume by Name, send a POST request to~/v2/volumes/actions. The body should contain the appropriateattributes for the respective action.## Attach a Block Storage Volume to a Droplet| Attribute | Details || ----------- | ------------------------------------------------------------------- || type | This must be attach || volume_name | The name of the block storage volume || droplet_id | Set to the Droplet's ID || region | Set to the slug representing the region where the volume is located |Each volume may only be attached to a single Droplet. However, up to fifteenvolumes may be attached to a Droplet at a time. Pre-formatted volumes will beautomatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOSDroplets created on or after April 26, 2018 when attached. On older Droplets,additional configurationis required.## Remove a Block Storage Volume from a Droplet| Attribute | Details || ----------- | ------------------------------------------------------------------- || type | This must be detach || volume_name | The name of the block storage volume || droplet_id | Set to the Droplet's ID || region | Set to the slug representing the region where the volume is located |

      Parameters

      • body: Volume_action_post_attach | Volume_action_post_detach

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<ActionsRequestBuilderPostQueryParameters>

        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 initiate an action on a block storage volume by Name, send a POST request to~/v2/volumes/actions. The body should contain the appropriateattributes for the respective action.## Attach a Block Storage Volume to a Droplet| Attribute | Details || ----------- | ------------------------------------------------------------------- || type | This must be attach || volume_name | The name of the block storage volume || droplet_id | Set to the Droplet's ID || region | Set to the slug representing the region where the volume is located |Each volume may only be attached to a single Droplet. However, up to fifteenvolumes may be attached to a Droplet at a time. Pre-formatted volumes will beautomatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOSDroplets created on or after April 26, 2018 when attached. On older Droplets,additional configurationis required.## Remove a Block Storage Volume from a Droplet| Attribute | Details || ----------- | ------------------------------------------------------------------- || type | This must be detach || volume_name | The name of the block storage volume || droplet_id | Set to the Droplet's ID || region | Set to the slug representing the region where the volume is located |

      Parameters

      • body: Volume_action_post_attach | Volume_action_post_detach

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<ActionsRequestBuilderPostQueryParameters>

        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