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

    Interface ActionsRequestBuilder

    Builds and executes requests for operations under /v2/droplets/{droplet_id}/actions

    interface ActionsRequestBuilder {
        byAction_id(action_id: number): WithAction_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                ActionsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ActionsGetResponse>;
        post(
            body:
                | Droplet_action_change_backup_policy
                | Droplet_action
                | Droplet_action_change_kernel
                | Droplet_action_enable_backups
                | Droplet_action_rebuild
                | Droplet_action_rename
                | Droplet_action_resize
                | Droplet_action_restore
                | Droplet_action_snapshot,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ActionsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ActionsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body:
                | Droplet_action_change_backup_policy
                | Droplet_action
                | Droplet_action_change_kernel
                | Droplet_action_enable_backups
                | Droplet_action_rebuild
                | Droplet_action_rename
                | Droplet_action_resize
                | Droplet_action_restore
                | Droplet_action_snapshot,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ActionsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAction_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To retrieve a list of all actions that have been executed for a Droplet, senda GET request to /v2/droplets/$DROPLET_ID/actions.The results will be returned as a JSON object with an actions key. This willbe set to an array filled with action objects containing the standardaction attributes.

      Parameters

      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:
              | Droplet_action_change_backup_policy
              | Droplet_action
              | Droplet_action_change_kernel
              | Droplet_action_enable_backups
              | Droplet_action_rebuild
              | Droplet_action_rename
              | Droplet_action_resize
              | Droplet_action_restore
              | Droplet_action_snapshot,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ActionsPostResponse>

      To initiate an action on a Droplet send a POST request to/v2/droplets/$DROPLET_ID/actions. In the JSON body to the request,set the type attribute to on of the supported action types:| Action | Details | Additionally Required Permission || ---------------------------------------- | ----------- | ----------- || enable_backups | Enables backups for a Droplet | || disable_backups | Disables backups for a Droplet | || change_backup_policy | Update the backup policy for a Droplet | || reboot | Reboots a Droplet. A reboot action is an attempt to reboot the Droplet in a graceful way, similar to using the reboot command from the console. | || power_cycle | Power cycles a Droplet. A powercycle action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | || shutdown | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the console. Since a shutdown command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a power_off action to ensure the Droplet is off. | || power_off | Powers off a Droplet. A power_off event is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications. | || power_on | Powers on a Droplet. | || restore | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin || password_reset | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin || resize | Resizes a Droplet. Set the size attribute to a size slug. If a permanent resize with disk changes included is desired, set the disk attribute to true. | droplet:create || rebuild | Rebuilds a Droplet from a new base image. Set the image attribute to an image ID or slug. | droplet:admin || rename | Renames a Droplet. | || change_kernel | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | || enable_ipv6 | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, additional OS-level configuration is required. | || snapshot | Takes a snapshot of a Droplet. | image:create |

      Parameters

      • body:
            | Droplet_action_change_backup_policy
            | Droplet_action
            | Droplet_action_change_kernel
            | Droplet_action_enable_backups
            | Droplet_action_rebuild
            | Droplet_action_rename
            | Droplet_action_resize
            | Droplet_action_restore
            | Droplet_action_snapshot

        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 a list of all actions that have been executed for a Droplet, senda GET request to /v2/droplets/$DROPLET_ID/actions.The results will be returned as a JSON object with an actions key. This willbe set to an array filled with action objects containing the standardaction attributes.

      Parameters

      Returns RequestInformation

    • To initiate an action on a Droplet send a POST request to/v2/droplets/$DROPLET_ID/actions. In the JSON body to the request,set the type attribute to on of the supported action types:| Action | Details | Additionally Required Permission || ---------------------------------------- | ----------- | ----------- || enable_backups | Enables backups for a Droplet | || disable_backups | Disables backups for a Droplet | || change_backup_policy | Update the backup policy for a Droplet | || reboot | Reboots a Droplet. A reboot action is an attempt to reboot the Droplet in a graceful way, similar to using the reboot command from the console. | || power_cycle | Power cycles a Droplet. A powercycle action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | || shutdown | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the console. Since a shutdown command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a power_off action to ensure the Droplet is off. | || power_off | Powers off a Droplet. A power_off event is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications. | || power_on | Powers on a Droplet. | || restore | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin || password_reset | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin || resize | Resizes a Droplet. Set the size attribute to a size slug. If a permanent resize with disk changes included is desired, set the disk attribute to true. | droplet:create || rebuild | Rebuilds a Droplet from a new base image. Set the image attribute to an image ID or slug. | droplet:admin || rename | Renames a Droplet. | || change_kernel | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | || enable_ipv6 | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, additional OS-level configuration is required. | || snapshot | Takes a snapshot of a Droplet. | image:create |

      Parameters

      • body:
            | Droplet_action_change_backup_policy
            | Droplet_action
            | Droplet_action_change_kernel
            | Droplet_action_enable_backups
            | Droplet_action_rebuild
            | Droplet_action_rename
            | Droplet_action_resize
            | Droplet_action_restore
            | Droplet_action_snapshot

        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