Skip to content
/
Returns a list of registe...

Returns a list of registered engines.

Request

Security
ApiKeyAuth
Query
limitinteger, [ 1 .. 1000 ]

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Default:100
Example:limit=50
cursorstring, [ 1 .. 4096 ] characters

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.

sortstring or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum:"id""-id""uuid""-uuid""type""-type""version""-version""name""-name"
Example:sort=id
curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/management/engines?limit=50&cursor=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itemsArray of objects(RegisteredEngine)
Example:
[
  {
    "id": "engine-123",
    "uuid": "54290b71-58cd-463d-bd62-7219d4c4d2d5",
    "type": "VIRTUALIZATION",
    "version": "6.0.7.0",
    "name": "My Favorite Engine",
    "hostname": "eng09.dev.delphix.com",
    "cpu_core_count": 4,
    "memory_size": 16000000000,
    "data_storage_capacity": 100000000000,
    "data_storage_used": 85000000000,
    "tags": [ … ],
    "connection_status": "OFFLINE",
    "connection_status_details": "Unable to authenticate with engine",
    "hyperscale_instance_ids": [ … ],
    "hyperscale_truststore_filename": "trustfile1",
    "hyperscale_truststore_password": "*****"
  }
]
response_metadataobject(PaginatedResponseMetadata)
Response
{
  "items": [
    { … }
  ],
  "response_metadata": {
    "prev_cursor": "string",
    "next_cursor": "string",
    "total": 0
  }
}