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

    Interface SnapshotsRequestBuilder

    Builds and executes requests for operations under /v2/snapshots

    interface SnapshotsRequestBuilder {
        bySnapshot_id(snapshot_id: number): WithSnapshot_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                SnapshotsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | SnapshotsGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                SnapshotsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): SnapshotsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    bySnapshot_id get toGetRequestInformation withUrl

    Methods

    • To list all of the snapshots available on your account, send a GET request to/v2/snapshots.The response will be a JSON object with a key called snapshots. This will beset to an array of snapshot objects, each of which will contain the standardsnapshot attributes.### Filtering Results by Resource TypeIt's possible to request filtered results by including certain query parameters.#### List Droplet SnapshotsTo retrieve only snapshots based on Droplets, include the resource_typequery parameter set to droplet. For example, /v2/snapshots?resource_type=droplet.#### List Volume SnapshotsTo retrieve only snapshots based on volumes, include the resource_typequery parameter set to volume. For example, /v2/snapshots?resource_type=volume.

      Parameters

      Returns Promise<undefined | SnapshotsGetResponse>

      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

    • To list all of the snapshots available on your account, send a GET request to/v2/snapshots.The response will be a JSON object with a key called snapshots. This will beset to an array of snapshot objects, each of which will contain the standardsnapshot attributes.### Filtering Results by Resource TypeIt's possible to request filtered results by including certain query parameters.#### List Droplet SnapshotsTo retrieve only snapshots based on Droplets, include the resource_typequery parameter set to droplet. For example, /v2/snapshots?resource_type=droplet.#### List Volume SnapshotsTo retrieve only snapshots based on volumes, include the resource_typequery parameter set to volume. For example, /v2/snapshots?resource_type=volume.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns SnapshotsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods