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

    Interface DangerousRequestBuilder

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

    interface DangerousRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DangerousRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete toDeleteRequestInformation withUrl

    Methods

    • To destroy a Droplet along with all of its associated resources, send a DELETErequest to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerousendpoint. The headers of this request must include an X-Dangerous key set totrue. To preview which resources will be destroyed, first query theDroplet's associated resources. This operation can not be reverse and shouldbe used with caution.A successful response will include a 202 response code and no content. Use thestatus endpoint to check on the success or failure of the destruction of theindividual resources.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      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 destroy a Droplet along with all of its associated resources, send a DELETErequest to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerousendpoint. The headers of this request must include an X-Dangerous key set totrue. To preview which resources will be destroyed, first query theDroplet's associated resources. This operation can not be reverse and shouldbe used with caution.A successful response will include a 202 response code and no content. Use thestatus endpoint to check on the success or failure of the destruction of theindividual resources.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns DangerousRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods