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

    Interface ActionsRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

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

      Some actions can be performed in bulk on tagged Droplets. The actions can beinitiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME withthe action arguments.Only a sub-set of action types are supported:- power_cycle- power_on- power_off- shutdown- enable_ipv6- enable_backups- disable_backups- snapshot (also requires image:create permission)

      Parameters

      • body: Droplet_action | Droplet_action_snapshot

        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 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • Some actions can be performed in bulk on tagged Droplets. The actions can beinitiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME withthe action arguments.Only a sub-set of action types are supported:- power_cycle- power_on- power_off- shutdown- enable_ipv6- enable_backups- disable_backups- snapshot (also requires image:create permission)

      Parameters

      • body: Droplet_action | Droplet_action_snapshot

        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