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 JobOrchestrators API

The JobOrchestrators API from Delphix — 12 operation(s) for joborchestrators.

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

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

This API exposes 16 operations across 12 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.

16 operations 12 paths 20 schemas 1 DELETE5 GET1 PATCH7 POST2 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 JobOrchestrators 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 16

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

JobOrchestrators 16
POST
/job-orchestrators
Create a job orchestrator.
create_job_orchestrator body → 201
GET
/job-orchestrators
Retrieve the list of job orchestrators.
get_job_orchestrators 3 params → 200
POST
/job-orchestrators/search
Search job orchestrators.
search_job_orchestrators 3 params body → 200
GET
/job-orchestrators/{jobOrchestratorId}
Retrieve a job orchestrator by ID.
get_job_orchestrator_by_id 1 param → 200
PATCH
/job-orchestrators/{jobOrchestratorId}
Update a job orchestrator.
update_job_orchestrator 1 param body → 200
DELETE
/job-orchestrators/{jobOrchestratorId}
Delete a job orchestrator.
delete_job_orchestrator 1 param → 200
GET
/job-orchestrators/{jobOrchestratorId}/tags
Get tags for a job orchestrator.
get_job_orchestrator_tags 1 param → 200
POST
/job-orchestrators/{jobOrchestratorId}/tags
Create tags for a job orchestrator.
create_job_orchestrator_tags 1 param body → 201
POST
/job-orchestrators/{jobOrchestratorId}/tags/delete
Delete tags for a job orchestrator.
delete_job_orchestrator_tags 1 param body → 204
GET
/job-orchestrators/{jobOrchestratorId}/application-settings
Returns a job orchestrator's application settings.
get_job_orchestrator_application_settings 4 params → 200
POST
/job-orchestrators/{jobOrchestratorId}/application-settings/search
Search a job orchestrator's application settings.
search_job_orchestrator_application_settings 4 params body → 200
PUT
/job-orchestrators/{jobOrchestratorId}/application-settings/{applicationSettingsId}
Update a job orchestrator's application setting value.
update_job_orchestrator_application_setting 2 params body → 200
GET
/job-orchestrators/{jobOrchestratorId}/queued-operations
Returns a job orchestrator's queued operations.
get_job_orchestrator_queued_operations 4 params → 200
POST
/job-orchestrators/{jobOrchestratorId}/queued-operations/search
Search a job orchestrator's queued operations.
search_job_orchestrator_queued_operations 4 params body → 200
POST
/job-orchestrators/{jobOrchestratorId}/support-bundle
Generates a bundle for requested nodes of a job orchestrator.
generate_job_orchestrator_support_bundle 1 param body → 200
PUT
/job-orchestrators/{jobOrchestratorId}/move-to-hyperscale
Move compliance nodes from a job orchestrator to a hyperscale instance.
move_compliance_nodes_to_hyperscale 1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Job (25 properties), JobOrchestrator (12 properties), QueuedOperation (11 properties), VirtualizationTask (8 properties). Each schema is shown below with its type and property counts.

JobOrchestrator
object
A job orchestrator.
12 properties
Tag
object
2 properties 2 required
MoveComplianceNodesToHyperscaleRequest
object
Parameters to move compliance nodes from a job orchestrator to a hyperscale orchestrator.
2 properties 2 required
VirtualizationTaskEvent
object
1 property
ComplianceApplicationSetting
object
An application setting of a compliance engine.
5 properties
QueuedOperation
object
A queued operation on a job orchestrator.
11 properties
Engine
object
2 properties
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
UpdateJobOrchestratorRequest
object
Parameters to update a job orchestrator.
2 properties
SearchBody
object
Search body.
1 property
VirtualizationTask
object
8 properties
ComplianceApplicationSettingUpdateRequest
object
Request to update an application setting value.
1 property 1 required
TagsResponse
object
1 property
CreateJobOrchestratorRequest
object
Parameters to create a job orchestrator.
4 properties 1 required
Job
object
An asynchronous task.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-joborchestrators-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 JobOrchestrators 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.