# Search PaaS Snapshots

Endpoint: POST /paas-snapshots/search
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.

## Request body:

  - `application/json` (unknown)
    A request body containing a filter expression. This enables searching
for items matching arbitrarily complex conditions. The list of
attributes which can be used in filter expressions is available
in the x-filterable vendor extension.
# Filter Expression Overview
**Note: All keywords are case-insensitive**
## Comparison Operators
| Operator | Description | Example |
|  --- | --- | --- |
| CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE |
| IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] |
| GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |
| GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |
| LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |
| LT | Tests if a field is less than a literal value | field1 LT 9.02 |
| NE | Tests if a field is not equal to a literal value | field1 NE 42 |
| EQ | Tests if a field is equal to a literal value | field1 EQ 42 |

## Search Operator
The SEARCH operator filters for items which have any filterable
attribute that contains the input string as a substring, comparison
is done case-insensitively. This is not restricted to attributes with
string values. Specifically `SEARCH '12'` would match an item with an
attribute with an integer value of `123`.
## Logical Operators
Ordered by precedence.
| Operator | Description | Example |
|  --- | --- | --- |
| NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |
| AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' |
| OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' |

## Grouping
Parenthesis `()` can be used to override operator precedence.
For example:
NOT (field1 LT 1234 AND field2 CONTAINS 'foo')
## Literal Values
| Literal | Description | Examples |
|  --- | --- | --- |
| Nil | Represents the absence of a value | nil, Nil, nIl, NIL |
| Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |
| Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |
| String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' |
| Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |
| List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] |

## Limitations
- A maximum of 8 unique identifiers may be used inside a filter expression.

## Request fields (application/json):

  - `filter_expression` (string)
    Example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"

## Request examples:

  - `Nested Object Comparison` (unknown)
    An example of a nested Object comparison testing that at least one repository has a
version which is equal to 19.0.0.

  - `Relative comparison` (unknown)
    An example of a relative comparison testing that field1 has a
value which is less than 123.

  - `Absence of an attribute value` (unknown)
    An example of using nil to test for the absence of a value for field2.

  - `Existence of an attribute value` (unknown)
    An example of using nil to test for the existence of a value for field2.

  - `Use of the CONTAINS operator` (unknown)
    An example of using the 'CONTAINS' operator to check if
field2 contains the string 'foo'. If field2 is string valued
then this is checking if 'foo' is a substring of field2. If
field2 is a list of strings then this is checking if 'foo'
is a member of the list.

  - `Use of the IN operator` (unknown)
    An example of using the 'IN' operator to check if field1
is an element of a list literal.

  - `Use of the SEARCH operator` (unknown)
    An example of using the 'SEARCH' operator to retrieve all elements
for which 'foo' is a substring of a filterable attribute.

  - `Overriding operator precedence` (unknown)
    An example of parenthesis being used to group operators & override
operator precedence.

## 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.