REST API for Oracle SOA Cloud Service

All REST Endpoints

Access Rules

View and manage the security rules for your service instances.

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

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

Activity Logs

View status information and activity messages of operations performed on your service instances.

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

Backup and Restore

Manage backup and restore operations.

Delete One or More Backups: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/deletedbackups
Start a Backup Operation: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups
Start a Restore Operation: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/restoredbackups
Update the Backup Configuration: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/backupconfig
View a Backup: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups/{backupId}
View All Backups: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups
View All Restoration Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/restoredbackups
View the Backup Configuration: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/backupconfig
View the Status of a Restoration Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/restoredbackups/{jobId}

IP Reservations

View and manage IP reservations for your Oracle SOA Cloud Service instances.

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

Create an IP Reservation: Method: post
Path: /paas/api/v1.1/network/{identityDomainId}/services/SOA/ipreservations
Delete an IP Reservation: Method: delete
Path: /paas/api/v1.1/network/{identityDomainId}/services/SOA/ipreservations/{ipResName}
View All IP Reservations: Method: get
Path: /paas/api/v1.1/network/{identityDomainId}/services/SOA/ipreservations

Provision Services

Delete provisioned instances and provision new instances.

Delete a Service Instance: Method: put
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}
Provision a New Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances

SSH Access

View and manage SSH keys for your Oracle SOA Cloud Service instances.

Add a New SSH Public Key: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/credentials/crednames/{credentialName}
Retrieve the SSH Key Description Using Query Parameters: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/credentials/crednames
Retrieve the SSH Key Value Using Query Parameters: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/credentials
View the SSH Key Description: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/credentials/crednames/{credentialName}
View the SSH Key Value: Method: get
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/credentials/{credentialName}

Scaling

Scale clusters and nodes on-demand in your Oracle SOA Cloud Service instances.

These endpoints are applicable only to Oracle Cloud Machine.

Add Storage: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/storage/add
Scale In a Cluster: Method: put
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/servers
Scale Out a Cluster: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/servers

Service Instances

View or delete service instances.

Add a Local Load Balancer: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceId}/servicecomponent
Disable or Enable the Oracle Managed Load Balancer: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceId}/loadbalancer/public/{command}
Start a Service Instance or Compute Node: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/hosts/start
Stop a Service Instance or Compute Node: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/hosts/stop
View a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceId}
View All Service Instances: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances

Update Database Credentials

Reset the database password that will be set for all infrastructure database schemas.

Update DB Credentials: Method: post
Path: /paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/updatedbcredentials