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

    Interface BackupsRequestBuilder

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

    interface BackupsRequestBuilder {
        get policy(): PolicyRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                BackupsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | BackupsGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                BackupsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): BackupsRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    policy

    Methods

    get toGetRequestInformation withUrl

    Accessors

    Methods

    • To retrieve any backups associated with a Droplet, send a GET request to/v2/droplets/$DROPLET_ID/backups.You will get back a JSON object that has a backups key. This will be set toan array of backup objects, each of which contain the standardDroplet backup attributes.

      Parameters

      Returns Promise<undefined | BackupsGetResponse>

      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 any backups associated with a Droplet, send a GET request to/v2/droplets/$DROPLET_ID/backups.You will get back a JSON object that has a backups key. This will be set toan array of backup objects, each of which contain the standardDroplet backup attributes.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns BackupsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods