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

    Interface SnapshotsRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To retrieve the snapshots that have been created from a Droplet, send a GETrequest to /v2/droplets/$DROPLET_ID/snapshots.You will get back a JSON object that has a snapshots key. This will be setto an array of snapshot objects, each of which contain the standard Dropletsnapshot attributes.

      Parameters

      Returns Promise<undefined | SnapshotsGetResponse>

      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 the snapshots that have been created from a Droplet, send a GETrequest to /v2/droplets/$DROPLET_ID/snapshots.You will get back a JSON object that has a snapshots key. This will be setto an array of snapshot objects, each of which contain the standard Dropletsnapshot attributes.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns SnapshotsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods