List Snapshots

GET /v1/snapshots

List user's own snapshots plus public system snapshots.

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
type	query	string | null	No		pattern=^(user|system)$, nullable
X-API-Key	header	string | null	No		nullable

Responses

200

Successful Response

application/json

Resolved schema:

{
  "type": "array",
  "items": {
    "properties": {
      "id": {
        "type": "string",
        "title": "Id"
      },
      "name": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Name"
      },
      "status": {
        "type": "string",
        "title": "Status"
      },
      "source_vm_id": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Source Vm Id"
      },
      "snapshot_type": {
        "type": "string",
        "title": "Snapshot Type"
      },
      "type": {
        "type": "string",
        "title": "Type",
        "default": "user"
      },
      "oci_image": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Oci Image"
      },
      "vcpu_count": {
        "anyOf": [
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ],
        "title": "Vcpu Count"
      },
      "memory_mb": {
        "anyOf": [
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ],
        "title": "Memory Mb"
      },
      "size_bytes": {
        "type": "integer",
        "title": "Size Bytes",
        "default": 0
      },
      "is_public": {
        "type": "boolean",
        "title": "Is Public",
        "default": false
      },
      "last_error": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Last Error"
      },
      "created_at": {
        "type": "string",
        "title": "Created At"
      },
      "updated_at": {
        "type": "string",
        "title": "Updated At"
      }
    },
    "type": "object",
    "required": [
      "id",
      "status",
      "snapshot_type",
      "created_at",
      "updated_at"
    ],
    "title": "SnapshotInfo"
  },
  "title": "Response List Snapshots V1 Snapshots Get"
}

Field details:

Field	Type	Required	Description	Constraints
[]	object	Yes
[].id	string	Yes
[].name	string | null	No		nullable
[].status	string	Yes
[].source_vm_id	string | null	No		nullable
[].snapshot_type	string	Yes
[].type	string	No		default="user"
[].oci_image	string | null	No		nullable
[].vcpu_count	integer | null	No		nullable
[].memory_mb	integer | null	No		nullable
[].size_bytes	integer	No		default=0
[].is_public	boolean	No		default=false
[].last_error	string | null	No		nullable
[].created_at	string	Yes
[].updated_at	string	Yes

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No