# Returns a list of Hyperscale instances.

Endpoint: GET /hyperscale-instances
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.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The Hyperscale instance entity ID.

  - `items.name` (string, required)
    The name of this hyperscale instance.

  - `items.hostname` (string, required)
    The hostname of this hyperscale instance.

  - `items.data_type` (string)
    The data type designation for the hyperscale deployment.
    Enum: "ORACLE", "MSSQL", "DELIMITED_FILES", "MONGO_DB"

  - `items.creation_date` (string)
    The date this hyperscale instance was registered.

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

  - `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.api_key` (string, required)
    API key to connect to the hyperscale instance.

  - `items.insecure_ssl` (boolean)
    Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though
the connection to the hyperscale instance 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 hyperscale instance'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 hyperscale instance over HTTPs.
Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname,
and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection
against a man-in-the-middle attack for connections to this hyperscale instance.
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 hyperscale instance. 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 this hyperscale instance.
    Enum: "CREATED", "DELETING"

  - `items.connection_status` (string)
    The status of the connection to the hyperscale instance.
    Enum: "ONLINE", "CONNECTION_ERROR", "BAD_CREDENTIALS"

  - `items.connection_status_details` (string)
    If set, details about the status of the connection to the hyperscale instance.

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