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

    Interface Destroy_with_associated_resourcesRequestBuilder

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

    interface Destroy_with_associated_resourcesRequestBuilder {
        get dangerous(): DangerousRequestBuilder;
        get retry(): RetryRequestBuilder;
        get selective(): SelectiveRequestBuilder;
        get status(): StatusRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Destroy_with_associated_resourcesGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Destroy_with_associated_resourcesRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    dangerous retry selective status

    Methods

    get toGetRequestInformation withUrl

    Accessors

    Methods

    • To list the associated billable resources that can be destroyed along with aDroplet, send a GET request to the/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.This endpoint will only return resources that you are authorized to see. Forexample, to see associated Reserved IPs, include the reserved_ip:read scope.The response will be a JSON object containing snapshots, volumes, andvolume_snapshots keys. Each will be set to an array of objects containinginformation about the associated resources.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Destroy_with_associated_resourcesGetResponse>

      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 list the associated billable resources that can be destroyed along with aDroplet, send a GET request to the/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.This endpoint will only return resources that you are authorized to see. Forexample, to see associated Reserved IPs, include the reserved_ip:read scope.The response will be a JSON object containing snapshots, volumes, andvolume_snapshots keys. Each will be set to an array of objects containinginformation about the associated resources.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods