Hyperscale Application Manager (v1.0.0)

Download OpenAPI specification:Download

Delphix Support: support@delphix.com URL: https://support.delphix.com

Hyperscale Application Manager API

ApiVersion

Returns the API version of service

Responses
200

OK

get/api-version
Response samples
application/json
{
  • "versionId": "v1.0.0"
}

ConnectorProperties

To create application properties for the given connector

Request
Request Body schema: application/json
required

The parameters to create application properties for the given connector

connector_type
required
string

The type of the connector.

Value: "ORACLE"
object

Properties config for the selected connector.

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/connector-properties
Request samples
application/json
{
  • "connector_type": "connector_type",
  • "properties": {
    }
}
Response samples
application/json
{
  • "connector_type": "connector_type",
  • "properties": {
    }
}

Returns a list of ConnectorProperties.

Responses
200

OK

500

Internal Service Unavailable.

get/connector-properties
Response samples
application/json
{
  • "connector_type": "ORACLE",
  • "properties": {
    }
}

Returns a list of ConnectorProperties.

Request
query Parameters
connector_type
string

Returns supported connector property definitions.

Value: "ORACLE"
property_metadata
boolean
Default: false

Whether to return detailed metadata for each property.

Responses
200

OK

500

Internal Service Unavailable.

get/connector-properties/property-definitions
Response samples
application/json
{
  • "connector_type": "ORACLE",
  • "properties": {
    }
}

Returns a ConnectorProperties by ID.

Request
path Parameters
connectorPropertiesId
required
integer <int64> >= 1

Numeric ID of the ConnectorProperties.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/connector-properties/{connectorPropertiesId}
Response samples
application/json
{
  • "connector_type": "connector_type",
  • "properties": {
    }
}

Update an existing ConnectorProperties.

Request
path Parameters
connectorPropertiesId
required
integer <int64> >= 1

Numeric ID of the ConnectorProperties.

Request Body schema: application/json
required

The updated ConnectorProperties.

connector_type
required
string

The type of the connector.

Value: "ORACLE"
object

Properties config for the selected connector.

Responses
200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/connector-properties/{connectorPropertiesId}
Request samples
application/json
{
  • "connector_type": "connector_type",
  • "properties": {
    }
}
Response samples
application/json
{
  • "connector_type": "connector_type",
  • "properties": {
    }
}

Delete an existing ConnectorProperties.

Request
path Parameters
connectorPropertiesId
required
integer <int64> >= 1

Numeric ID of the ConnectorProperties.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/connector-properties/{connectorPropertiesId}

InstantClient

Upload an instant client zip file.

Request
Request Body schema: multipart/form-data
file
required
string <binary>

The file to be uploaded.

Responses
200

Instant Client zip file uploaded successfully.

400

Invalid Input provided.

500

Internal Service Unavailable.

post/instant-client
Response samples
application/json
{
  • "version": "21.0.0.0.0"
}

Returns the version of uploaded instant client.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/instant-client
Response samples
application/json
{
  • "version": "21.0.0.0.0"
}

Delete an existing Instant Client.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/instant-client

HyperscaleServices

Start hyperscale services for the given connectorPropertiesId

Request
Request Body schema: application/json
required
connector_properties_id
required
integer <int64>

The ID of the connector properties for which hyperscale services needs to start.

Responses
201

Started

400

Invalid Input provided.

500

Internal Service Unavailable.

post/hyperscale-services
Request samples
application/json
{
  • "connector_properties_id": 1
}
Response samples
application/json
{}

Restart the last running hyperscale services

Responses
201

Restarted

400

Invalid Input provided.

500

Internal Service Unavailable.

put/hyperscale-services
Response samples
application/json
{}

Stop hyperscale services for the given connectorPropertiesId

Request
Request Body schema: application/json
required
connector_properties_id
required
integer <int64>

The ID of the connector properties for which hyperscale services needs to start.

Responses
201

Stopped

404

Object Not Found.

500

Internal Service Unavailable.

delete/hyperscale-services
Request samples
application/json
{
  • "connector_properties_id": 1
}
Response samples
application/json
{}

Returns the latest hyperscale services details

Responses
200

OK

400

Hyperscale Services are not running

404

Object Not Found.

500

Internal Service Unavailable.

get/hyperscale-services
Response samples
application/json
{
  • "id": 0,
  • "connectorPropertiesId": 0,
  • "apiKey": "string",
  • "url": "string",
  • "status": "STARTING",
  • "errorMessage": "string"
}

SupportBundle

Generates support bundle

Generates support bundle

Request
query Parameters
include_hyperscale_bundle
boolean
Default: true

Whether to include hyperscale services logs in the support bundle.

Responses
201

Success

400

Invalid Input provided.

500

Internal Service Unavailable.

post/support-bundle
Response samples
application/json
{
  • "id": 1,
  • "reference": "application-manager-support-20240313-13-18-04.tar.gz",
  • "status": "SUCCEEDED",
  • "start_time": "2024-03-13T13:18:05.366909Z",
  • "end_time": "2024-03-13T13:19:05.955041Z"
}

Cancel Support Bundle Generation

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

put/support-bundle
Response samples
application/json
{
  • "id": 1,
  • "reference": "application-manager-support-20240313-13-18-04.tar.gz",
  • "status": "SUCCEEDED",
  • "start_time": "2024-03-13T13:18:05.366909Z",
  • "end_time": "2024-03-13T13:19:05.955041Z"
}

Returns the status of the support bundle task.

Responses
200

OK

get/support-bundle/status
Response samples
application/json
{
  • "id": 1,
  • "reference": "application-manager-support-20240313-13-18-04.tar.gz",
  • "status": "SUCCEEDED",
  • "start_time": "2024-03-13T13:18:05.366909Z",
  • "end_time": "2024-03-13T13:19:05.955041Z"
}

Downloads

Downloads the support bundle generated using /support-bundle POST API.

Downloads the support bundle generated using /support-bundle POST API.

Responses
200

OK

404

Object Not Found.

get/support-bundle
Response samples
application/json
[
  • {
    }
]