Engines
GET /engines
List all engines.
Example Responses
Response Code: 200
{
"items": [
{
"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",
"registration_status": "CONNECTED",
"connection_status": "ONLINE",
"last_connection_time": "2021-03-29T15:10:00.976Z",
"boot_storage_capacity": 96000000000,
"cpu_core_count": 4,
"cpu_type": "Intel(R) Xeon(R) CPU E5-2690 v3 @ 2.60GHz",
"memory_size": 16000000000,
"data_storage_capacity": 100000000000,
"data_storage_used": 85000000000
}
],
"errors": [
{
"message": "string",
"object_name": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
Response Schema
Status Code: 200
ListEnginesResponse
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » items | [Engine] | false | none | [A Delphix Virtualization or Masking Engine.] |
| »» id | string | false | none | The Engine object entity ID. |
| »» uuid | string¦null | false | none | The unique identifier generated by this engine. |
| »» type | string¦null | false | none | The type of this engine. |
| »» version | string¦null | false | none | The engine version. |
| »» name | string | false | none | The name of this engine. |
| »» hostname | string | false | none | The hostname of this engine. |
| »» registration_status | string¦null | false | none | The registration status of this engine. |
| »» connection_status | string¦null | false | none | The connection status of this engine. |
| »» last_connection_time | string(date-time)¦null | false | none | The last time a connection was established with this engine. |
| »» boot_storage_capacity | integer(int64)¦null | false | none | The total amount of storage allocated to the engine's boot partition, in bytes. |
| »» cpu_core_count | integer(int32)¦null | false | none | The total number of CPU cores on this engine. |
| »» cpu_type | string¦null | false | none | The model of the processors on this engine. |
| »» memory_size | integer(int64)¦null | false | none | The total amount of memory on this engine, in bytes. |
| »» data_storage_capacity | integer(int64)¦null | false | none | The total amount of storage allocated for engine objects and system metadata, in bytes. |
| »» data_storage_used | integer(int64)¦null | false | none | The amount of storage used by engine objects and system metadata, in bytes. |
| » errors | [Error] | false | none | Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request. |
| »» message | string | false | read-only | Message providing more detail about the error that occurred, if available. |
| »» object_name | string | false | read-only | Name of the object affected by the error. |
Enumerated Values
| Property | Value |
|---|---|
| type | VIRTUALIZATION |
| type | MASKING |
| type | BOTH |
| type | UNSET |
| registration_status | CONNECTED |
| registration_status | PENDING |
| connection_status | ONLINE |
| connection_status | OFFLINE |
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth
GET /engines/{engineId}
Returns an engine by ID.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| engineId | path | string | true | The ID of the engine. |
Example Responses
Response Code: 200
|
Responses
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth
Bookmarks
GET /bookmarks
List all bookmarks.
Example Responses
Response Code: 200
|
Responses
Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
Response Schema
Status Code: 200
ListBookmarksResponse
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » items | [Bookmark] | false | none | [A Data Control Tower object that references points in time for one or more datasets.] |
| »» id | string | false | read-only | The Bookmark object entity ID. |
| »» name | string | true | none | The user-defined name of this bookmark. |
| »» creation_date | string(date-time) | false | read-only | The date and time that this bookmark was created. |
| »» vdb_ids | [string] | true | none | The list of VDB IDs associated with this bookmark. |
| »» retention | integer(int64) | false | none | The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. |
| »» status | string¦null | false | read-only | A message with details about operation progress or state of this bookmark. |
| » errors | [Error] | false | none | Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request. |
| »» message | string | false | read-only | Message providing more detail about the error that occurred, if available. |
| »» object_name | string | false | read-only | Name of the object affected by the error. |
To perform this operation, you must be authenticated by means of one of the following methods: ApiKeyAuth