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

    Interface SelectiveRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    delete toDeleteRequestInformation withUrl

    Methods

    • To destroy a Droplet along with a sub-set of its associated resources, send aDELETE request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selectiveendpoint. The JSON body of the request should include reserved_ips, snapshots, volumes,or volume_snapshots keys each set to an array of IDs for the associatedresources to be destroyed. The IDs can be found by querying the Droplet'sassociated resources. Any associated resource not included in the requestwill remain and continue to accrue changes on your account.A successful response will include a 202 response code and no content. Usethe status endpoint to check on the success or failure of the destruction ofthe individual resources.

      Parameters

      • body: Selective_destroy_associated_resource

        An object containing information about a resource to be scheduled for deletion.

      • 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 a sub-set of its associated resources, send aDELETE request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selectiveendpoint. The JSON body of the request should include reserved_ips, snapshots, volumes,or volume_snapshots keys each set to an array of IDs for the associatedresources to be destroyed. The IDs can be found by querying the Droplet'sassociated resources. Any associated resource not included in the requestwill remain and continue to accrue changes on your account.A successful response will include a 202 response code and no content. Usethe status endpoint to check on the success or failure of the destruction ofthe individual resources.

      Parameters

      • body: Selective_destroy_associated_resource

        An object containing information about a resource to be scheduled for deletion.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns SelectiveRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods