# Get all PaaS Snapshots

Endpoint: GET /paas-snapshots
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort snapshot results by. A field prefixed with `-` indicates descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The ID of the PaaS Snapshot.
    Example: snapshot-123

  - `items.name` (string)
    The name of the PaaS Snapshot.
    Example: my-snapshot-123

  - `items.size` (integer)
    The size of the PaaS Snapshot in bytes.
    Example: 123456789

  - `items.snapshot_location` (string)
    The location of the PaaS Snapshot. This is platform specific and may represent a logical unique identifier, a location on storage, ...

  - `items.database_id` (string)
    The ID of the PaaS Database.
    Example: my-db-123

  - `items.instance_id` (string)
    The ID of the PaaS Instance.
    Example: my-db-123

  - `items.database_name` (string)
    The name of the PaaS Database.
    Example: my-db

  - `items.instance_name` (string)
    The name of the PaaS Database instance.
    Example: my-db

  - `items.timestamp` (string)
    The timestamp of the PaaS Snapshot. If this snapshot represents a range, this is the start timestamp of the range.
    Example: 2021-05-01T08:51:34.148Z

  - `items.end_timestamp` (string)
    The last point in time data can be provisioned or refresh to. If the snapshots represents a single point in time, this is equal to timestamp. Otherwise, it must be greater than timestamp, and indicates than any timestamp between timestamp and end_timestamp can be used. If this is null, it indicates the snapshot is valid until the current time.
    Example: 2025-05-01T09:51:34.148Z

  - `items.is_public` (boolean)
    Whether this snapshot is public or not.
    Example: true

  - `items.is_dct_managed` (boolean)
    Whether this snapshot was created via DCT or not. All snapshots can be used to provision or refresh, but only DCT managed snapshots can be deleted via DCT.
    Example: true

  - `items.is_automated_backup` (boolean)
    Whether this snapshot represents an automated backup. Automated backups are point-in-time backups with a retention period that represent a range of time rather than a single point.
    Example: true

  - `items.cloud_account_id` (string)
    The ID of the Cloud Account.
    Example: my-db-123

  - `items.timeflow_id` (string)
    The ID of the PaaSTimeflow this snapshot belongs to.
    Example: timeflow-123

  - `items.masked_by_execution_id` (string)
    The ID of the compliance job collection execution that masked this snapshot, if any.

  - `items.masked_by_collection_id` (string)
    The ID of the compliance job collection that masked this snapshot, if any.

  - `items.tags` (array)

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.tags.mirror_on_cloud` (boolean)
    Whether this tag is mirrored from/to the Cloud Provider account hosting the PaaS Database or Instance. Not applicable to non PaaS objects.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.