How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Delphix HyperscaleInstance API

The HyperscaleInstance API from Delphix — 9 operation(s) for hyperscaleinstance.

Delphix HyperscaleInstance API is one of 60 APIs that Delphix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include HyperscaleInstance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 9 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

Requests are made against a single base URL, /dct/v3.

13 operations 9 paths 20 schemas 1 DELETE3 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.28.0
Base URL
https://help-api.delphix.com/dct/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Delphix HyperscaleInstance API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 3 GET, 1 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

HyperscaleInstance 13
POST
/hyperscale-instances
Register a Hyperscale instance
register_hyperscale_instance 1 param body → 201
GET
/hyperscale-instances
Returns a list of Hyperscale instances.
get_hyperscale_instances 3 params → 200
POST
/hyperscale-instances/search
Search for Hyperscale instances.
search_hyperscale_instances 3 params body → 200
GET
/hyperscale-instances/{hyperscaleInstanceId}
Returns a Hyperscale Instance by ID.
get_hyperscale_instance_by_id 1 param → 200
PATCH
/hyperscale-instances/{hyperscaleInstanceId}
Update an Hyperscale Instance
update_hyperscale_instance 1 param body → 200
DELETE
/hyperscale-instances/{hyperscaleInstanceId}
Unregister a Hyperscale Instance.
unregister_hyperscale_instance 1 param → 200
POST
/hyperscale-instances/{hyperscaleInstanceId}/tags
Create tags for a Hyperscale Instance.
create_hyperscale_instance_tags 1 param body → 201
GET
/hyperscale-instances/{hyperscaleInstanceId}/tags
Get tags for a Hyperscale Instance.
get_hyperscale_instance_tags 1 param → 200
POST
/hyperscale-instances/{hyperscaleInstanceId}/tags/delete
Delete tags for a Hyperscale Instance.
delete_hyperscale_instance_tags 1 param body → 204
POST
/hyperscale-instances/{hyperscaleInstanceId}/sync-engines
Sync the global object from a source engine to engines on a Hyperscale Instance.
sync_engines_hyperscale_instance 1 param body → 200
POST
/hyperscale-instances/{hyperscaleInstanceId}/add-engine
Add an engine to a Hyperscale Instance.
add_engine_to_hyperscale_instance 1 param body → 200
POST
/hyperscale-instances/{hyperscaleInstanceId}/remove-engine
Remove an engine from a Hyperscale Instance.
remove_engine_from_hyperscale_instance 1 param body → 200
PUT
/hyperscale-instances/{hyperscaleInstanceId}/move-to-job-orchestrator
Move compliance nodes from a hyperscale orchestrator to a job orchestrator.
move_compliance_nodes_to_job_orchestrator 1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are HyperscaleInstance (30 properties), Job (25 properties), HyperscaleInstanceRegistrationParameter (23 properties), HyperscaleInstanceUpdateParams (21 properties). Each schema is shown below with its type and property counts.

Tag
object
2 properties 2 required
HyperscaleInstance
object
A registered Hyperscale instance's connection and authentication settings.
30 properties 4 required
VirtualizationTaskEvent
object
1 property
Engine
object
2 properties
MoveComplianceNodesToJobOrchestratorRequest
object
Parameters to move compliance nodes from a hyperscale orchestrator to a job orchestrator.
2 properties 2 required
PaginatedResponseMetadata
object
3 properties
JobTaskEvent
object
1 property
DeleteTag
object
3 properties
JobTask
object
8 properties
TagsRequest
object
1 property 1 required
MoveComplianceNodesResponse
object
Response for compliance node movement operations.
1 property
HyperscaleInstanceRegistrationParameter
object
Parameters to register and authenticate a Hyperscale instance
23 properties 4 required
SearchBody
object
Search body.
1 property
VirtualizationTask
object
8 properties
SyncEnginesHyperscaleParameters
object
Parameters to sync the global object from a source engine to a list of target engines registered with a Hyperscale Instance.
2 properties 2 required
EngineIdBody
object
The ID of the registered engine.
1 property
TagsResponse
object
1 property
HyperscaleDataTypeEnum
string
The data type designation for the hyperscale deployment.
Job
object
An asynchronous task.
25 properties
HyperscaleInstanceUpdateParams
object
Parameters to update a Hyperscale instances.
21 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-hyperscaleinstance-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

Delphix Algorithms API
Delphix Bookmarks API
Delphix CDB DSources API
Delphix CDBs API
Delphix Classifiers API
Delphix CloudAccounts API
Delphix ComplianceJobCollections API
Delphix ComplianceJobs API
Delphix ComplianceNodes API
Delphix Connectivity API
Delphix Connectors API
Delphix DatabaseTemplates API
Where this information came from

This is an independent, third-party profile of Delphix HyperscaleInstance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.