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

    Interface WithSnapshot_ItemRequestBuilder

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

    interface WithSnapshot_ItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithSnapshot_GetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithSnapshot_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Methods

    • Both Droplet and volume snapshots are managed through the /v2/snapshots/endpoint. To delete a snapshot, send a DELETE request to/v2/snapshots/$SNAPSHOT_ID.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      error when the service returns a 400 status code

      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 information about a snapshot, send a GET request to/v2/snapshots/$SNAPSHOT_ID.The response will be a JSON object with a key called snapshot. The value ofthis will be an snapshot object containing the standard snapshot attributes.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithSnapshot_GetResponse>

      error when the service returns a 400 status code

      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

    • Both Droplet and volume snapshots are managed through the /v2/snapshots/endpoint. To delete a snapshot, send a DELETE request to/v2/snapshots/$SNAPSHOT_ID.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To retrieve information about a snapshot, send a GET request to/v2/snapshots/$SNAPSHOT_ID.The response will be a JSON object with a key called snapshot. The value ofthis will be an snapshot object containing the standard snapshot attributes.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods