Get snapshot details

GET https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/buckets/:bucket_name/snapshots/:version

Returns snapshot metadata. See snapshot documentation.

Request

Path Parameters

provider_id string required
Provider ID

org_id string required
Organization ID

bucket_name string required
Bucket name

version string required
Snapshot version (UNIX nanosecond-precision timestamp).

Responses

• 200

  • OK
  • application/json

• Schema

• Example (auto)

Schema

snapshot object
A point-in-time snapshot of a bucket. See snapshot documentation.

version string
Snapshot version (UNIX nanosecond-precision timestamp).

created_at date-time

bucket string
Name of the bucket this snapshot belongs to.

description string
Optional name or description.

{
  "snapshot": {
    "version": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "bucket": "string",
    "description": "string"
  }
}

Unexpected error

• application/json
• Schema
• Example (auto)

Schema

message string

{
  "message": "string"
}

Authorization: X-Tigris-Signature

name: X-Tigris-Signature
type: apiKey
in: header
description: HMAC-SHA256 of the canonical request signed using the signing key.
To create the signature, concatenate the HTTP method, URL, timestamp, and nonce with a newline character in between.
Then, calculate the HMAC-SHA256 of the concatenated string using the signing key. Example:

Create the `canonical_request` as:

POST https://mgmt.storage.dev/provider/your-provider-id/orgs/user-org-id/provision 1731703213870 f8d133cb-5a42-47b1-9ef2-874bb55bab72

Then, calculate HMAC-SHA256 of the canonical request using the signing key as:

Signature = hex(sha256sign(canonical_request, "signing_key"))

```text
name: X-Tigris-Nonce
type: apiKey
in: header
description: Random unique string to identify the request and prevent replay attacks. Example: "f8d133cb-5a42-47b1-9ef2-874bb55bab72"

name: X-Tigris-Time
type: apiKey
in: header
description: Unix timestamp in milliseconds of the request. Example: 1731703213870

Code Examples

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/buckets/:bucket_name/snapshots/:version");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Tigris-Signature", "<X-Tigris-Signature>");
request.Headers.Add("X-Tigris-Nonce", "<X-Tigris-Nonce>");
request.Headers.Add("X-Tigris-Time", "<X-Tigris-Time>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());