REST API for Oracle Data Hub Cloud Service

All REST Endpoints

Access Rules

View and manage network security rules for your Service instance virtual machines.

Create an Access Rule: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/accessrules
Update an Access Rule: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/accessrules/{ruleName}
View All Access Rules: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/accessrules

Activity Logs

View status information and activity messages of operations performed on your Oracle Data Hub Cloud Service instances.

View Activities for a Service Instance: Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/filter
View the Status of an Operation by Job Id: Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}

Backups and Restorations

Manage backup and restore operations on your Oracle Data Hub Cloud Service instances, including updating the backup configuration, and disabling or enabling the backup service for a service instance.

Delete a Backup: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/deletedbackups
Initiate an On-demand Backup: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backups
Restore a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/restoredbackups
Update the Backup Configuration: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backupconfig
View a Backup: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backups/{backupId}
View All Backups: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backups
View All Restoration Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/restoredbackups
View the Backup Configuration: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backupconfig
View the Status of a Restoration Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/restoredbackups/{jobId}

Patches

Precheck, apply and roll back patches on Oracle Data Hub Cloud Service instances.

Apply a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/patches/{patchId}
Perform a Patching Precheck: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/patches/checks/{patchId}
Rollback a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/patches/{rollbackId}/rollback
View Applied Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/patches/applied
View Available Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/patches/available

SSH Access

View and manage secure shell (SSH) public keys for Oracle Data Hub Cloud Service instances.

Add a New SSH Public Key: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/credentials/crednames/{credentialName}

Service Instances

Manage the life cycle of Oracle Data Hub Cloud Service instances.

Add Storage to an Existing or New Volume: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/storage/add
Check Health of a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/healthcheck
Create a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances
Delete a Service Instance: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}
Restart a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/hosts/restart
Scale In a Service Instance: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/servers
Scale Out a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/servers
Scale Up or Scale Down a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/hosts/scale
Start a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/hosts/start
Stop a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/hosts/stop
View a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}
View All Service Instances: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances

Tags and Assignments

Create and manage tags and their assignments.

Create and Assign Tags: Method: post
Path: /paas/api/v1.1/tags/{identityDomainId}/tags
Create and Delete Tag Assignments: Method: put
Path: /paas/api/v1.1/tags/{identityDomainId}/assignments
Delete a Tag: Method: delete
Path: /paas/api/v1.1/tags/{identityDomainId}/tags/{tagKey}/{tagValue}
Delete All Tags by Key: Method: delete
Path: /paas/api/v1.1/tags/{identityDomainId}/tags/{tagKey}
Delete Multiple Tags: Method: put
Path: /paas/api/v1.1/tags/{identityDomainId}/tags
List All Tags: Method: get
Path: /paas/api/v1.1/tags/{identityDomainId}/tags