# Search for engines.

Endpoint: POST /management/engines/search
Version: 3.18.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 results by. A property name with a prepended '-' signifies 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 Engine object entity ID.

  - `items.uuid` (string)
    The unique identifier generated by this engine.

  - `items.type` (string)
    The type of this engine.
    Enum: "VIRTUALIZATION", "MASKING", "BOTH", "UNSET"

  - `items.version` (string)
    The engine version.

  - `items.name` (string)
    The name of this engine.

  - `items.ssh_public_key` (string)
    The ssh public key of this engine.

  - `items.hostname` (string)
    The hostname of this engine.

  - `items.cpu_core_count` (integer)
    The total number of CPU cores on this engine.

  - `items.memory_size` (integer)
    The total amount of memory on this engine, in bytes.

  - `items.data_storage_capacity` (integer)
    The total amount of storage allocated for engine objects and system metadata, in bytes.

  - `items.data_storage_used` (integer)
    The amount of storage used by engine objects and system metadata, in bytes.

  - `items.insecure_ssl` (boolean)
    Allow connections to the engine over HTTPs without validating the TLS certificate. Even though
the connection to the engine might be performed over HTTPs, setting this property eliminates
the protection against a man-in-the-middle attach for connections to this engine. Instead,
consider creating a truststore with a Certificate Authority to validate the engine's certificate,
and set the truststore_filename property.

  - `items.unsafe_ssl_hostname_check` (boolean)
    Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs.
Setting this value must only be done if the TLS certificate of the engine does not match the hostname,
and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection
against a man-in-the-middle attack for connections to this engine.
This is ignored if insecure_ssl is set.

  - `items.truststore_filename` (string)
    File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore
must be available at /etc/config/certs/<truststore_filename>

  - `items.truststore_password` (string)
    Password to read the truststore.

  - `items.status` (string)
    the status of the engine
    Enum: "CREATED", "DELETING"

  - `items.connection_status` (string)
    The status of the connection to the engine. Deprecated; use "engine_connection_status" instead.
    Enum: "ONLINE", "OFFLINE"

  - `items.engine_connection_status` (string)
    The state of the connection to the engine.
    Enum: "ONLINE", "CONNECTION_ERROR", "MISSING_CREDENTIALS", "BAD_CREDENTIALS"

  - `items.connection_status_details` (string)
    If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead.

  - `items.engine_connection_status_details` (string)
    If set, details about the state of the connection to the engine.

  - `items.username` (string)
    The virtualization domain admin username.

  - `items.password` (string)
    The virtualization domain admin password.

  - `items.masking_username` (string)
    The masking admin username.

  - `items.masking_password` (string)
    The masking admin password.

  - `items.hashicorp_vault_username_command_args` (array)
    Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine.
    Example: [["kv","get","-field=username","kv-v2/delphix-secrets/delphixUser"]]

  - `items.hashicorp_vault_masking_username_command_args` (array)
    Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine.
    Example: [["kv","get","-field=username","kv-v2/delphix-secrets/delphixUser"]]

  - `items.hashicorp_vault_password_command_args` (array)
    Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine.
    Example: [["kv","get","-field=password","kv-v2/delphix-secrets/delphixUser"]]

  - `items.hashicorp_vault_masking_password_command_args` (array)
    Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine.
    Example: [["kv","get","-field=password","kv-v2/delphix-secrets/delphixUser"]]

  - `items.masking_hashicorp_vault_id` (integer)
    Reference to the Hashicorp vault to use to retrieve masking engine credentials.

  - `items.hashicorp_vault_id` (integer)
    Reference to the Hashicorp vault to use to retrieve virtualization engine credentials.

  - `items.tags` (array)
    The tags to be created for this engine.

  - `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.masking_memory_used` (integer)
    The current amount of memory used by running masking jobs in bytes.

  - `items.masking_allocated_memory` (integer)
    The maximum amount of memory available for running masking jobs in bytes.

  - `items.masking_jobs_running` (integer)
    The number of masking jobs currently running.

  - `items.masking_max_concurrent_jobs` (integer)
    The maximum number of masking jobs that can be running at the same time.

  - `items.masking_available_cores` (integer)
    The number of CPU cores available to the masking engine.

  - `items.hyperscale_instance_ids` (array)
    List of Hyperscale Instances that this engine is connected to.

  - `items.hyperscale_truststore_filename` (string)
    File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances.

  - `items.hyperscale_truststore_password` (string)
    Password to read the truststore as expected by associated hyperscale instances.

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