All REST Endpoints

Access Rules
View and manage the access rules for your Oracle Java Cloud Service instances.

These endpoints are not applicable to service instances created on Oracle Cloud Infrastructure. To change access rules for Oracle Cloud Infrastructure service instances, see the security-related Core Services APIs in Oracle API Documentation for Oracle Cloud Infrastructure Services.

Add an Access Rule
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/accessrules
Disable, Enable or Delete an Access Rule
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/accessrules/{ruleName}
View All Access Rules
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/accessrules
View All Rule Parameters
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/accessrules/ruleParameters
Activity Logs
View status information and activity messages of operations performed on your Oracle Java Cloud Service instances.
List All Activity
Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/filter
View Activity by Log Id
Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/message/{logId}
View the Status of an Operation by Job Id
Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}
Application Security
Manage protected context roots with Oracle Identity Cloud Service and the Cloudgate Web Tier Policy.
Retrieve the Web Tier Policy
Method: get
Path: /__auth-mgmt-app/webtierpolicy
Update the Web Tier Policy
Method: put
Path: /__auth-mgmt-app/webtierpolicy
Association Management
Associate your Oracle Java Cloud Service instance with a different infrastructure schema database.

The endpoint may not be available for all service instances.

Associate a Service Instance With a Different Database
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/associations/recreate
Automatic Scaling
Manage automatic (auto) scaling out and scaling in of clusters in your Oracle Java Cloud Service instances.

These endpoints are not applicable to service instances created on Oracle Cloud Infrastructure.

Create an Auto Scaling Policy
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/policies
Delete an Auto Scaling Policy
Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/policies
Update an Auto Scaling Policy
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/policies
View an Auto Scaling Policy
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/policies
View the Events Triggered by an Auto Scaling Policy
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/activities
Backups and Restorations
Manage backup and restore operations on your Oracle Java Cloud Service instances, including updating the backup configuration, and disabling or enabling the backup service for a service instance.
Add the Backup Service
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig/create
Delete a Backup (Asynchronous)
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/deletedbackups
Delete a Backup (Synchronous)
Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups/{backupId}
Initiate an On-demand Backup
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups
Move a Backup (Download or Archive)
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups/{backupId}
Restore a Service Instance
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/restoredbackups
Update the Backup Configuration
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig
View a Backup
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups/{backupId}
View a Deleted Backup
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/deletedbackups/{jobId}
View All Backups
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups
View All Deleted Backups
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/deletedbackups
View All Restoration Operations
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/restoredbackups
View the Backup Configuration
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig
View the Status of a Restoration Operation
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/restoredbackups/{jobId}
IP Reservations
View and manage IP reservations for your Oracle Java Cloud Service instances.

These endpoints are not available on Oracle Cloud Infrastructure.

Create an IP Reservation
Method: post
Path: /paas/api/v1.1/network/{identityDomainId}/services/jaas/ipreservations
Delete an IP Reservation
Method: delete
Path: /paas/api/v1.1/network/{identityDomainId}/services/jaas/ipreservations/{ipResName}
View All IP Reservations
Method: get
Path: /paas/api/v1.1/network/{identityDomainId}/services/jaas/ipreservations
Patches
Patch your Oracle Java Cloud Service instances.
Apply a Patch
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/{patchId}
Perform a Patching Precheck
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks/{patchId}
Rollback a Patch
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/{rollbackId}/rollback
View a Patch Operation
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/applied/{id}
View All Patching Precheck Operations
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks
View Applied Patches
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/applied
View Available Patches
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/available
View the Status of a Patching Precheck Operation
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks/job/{jobId}
SSH Access
View and manage SSH keys for your Oracle Java Cloud Service instances.
Add a New SSH Public Key
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/crednames/{credentialName}
Retrieve the SSH Key Description Using Query Parameters
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/credentials/crednames
Retrieve the SSH Key Value Using Query Parameters
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/credentials
View the SSH Key Description
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/crednames/{credentialName}
View the SSH Key Value
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/{credentialName}
Service Instances
Create and manage Oracle Java Cloud Service instances.
Add a User-Managed Load Balancer
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/servicecomponent
Add an Access Control Rule to a Load Balancer
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/{loadBalancerName}/rules
Add Storage to an Existing or New Volume
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/storage/add
Change the Database Schema Password
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/updatedbcredentials
Change the Node Manager Credentials
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/update
Create a Service Instance
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances
Delete a Service Instance
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}
Delete an Access Control Rule on a Load Balancer
Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/{loadBalancerName}/rules/{ruleName}
Delete the Oracle-Managed Load Balancer
Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/{loadBalancerName}
Disable or Enable the Load Balancer
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/public/{command}
Scale In a Service Instance
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/servers
Scale Out a Service Instance
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/servers
Scale Up or Scale Down a Service Instance
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/hosts/scale
Stop and Start a Service Instance and Individual VMs
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/hosts/{command}
Update a Service Instance Configuration
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/config
Update an Access Control Rule on a Load Balancer
Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/{loadBalancerName}/rules/{ruleName}
View a Service Instance
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}
View All Instances by Identity Domain ID
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/instances
View All Service Instances
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances
View Details of the Load Balancer
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer
View Health Data for a Service Instance
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/healthcheck
View Tags for a Service Instance
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/tags
Snapshots
Create and manage snapshots of Oracle Java Cloud Service instances.
Create a Snapshot
Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots
Delete a Snapshot
Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots/{snapshotName}
View a Snapshot
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots/{snapshotName}
View All Snapshots
Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots
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