REST API for MySQL Cloud Service

All REST Endpoints

Access Rules

View and manage network access rules for the MySQL Cloud Service instance virtual machines.

Add an Access Rule: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/accessrules
Enable, Disable, or Delete an Access Rule: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/accessrules/{ruleName}
View All Access Rules: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/accessrules

Activity Logs

View status information and activity messages of operations performed on your MySQL 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}

Backups

Manage backup and restore operations on MySQL Cloud Service instances.

Delete a Backup: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/deletedbackups
Start a Backup Operation: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/backups
Start a Restore Operation: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/restoredbackups
Update a Backup Configuration: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/backupconfig
View a Backup: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/backups/{backupId}
View a Backup Configuration: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/backupconfig
View a Deleted Backup: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/deletedbackups/{jobId}
View All Backup Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/backups
View All Deleted Backups: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/deletedbackups
View All Restore Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/restoredbackups
View Job Status of a Restore Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/restoredbackups/{jobId}

Health Monitoring

Monitor the health of MySQL Cloud Service instances.

Monitor a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/healthcheck

IP Reservations

View and manage IP reservations for your MySQL Cloud Service instances.

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

Patches

Patch MySQL Cloud Service instances.

Apply a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/{patchId}
Precheck Application of a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/checks/{patchId}
Rollback a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/{rollbackId}/rollback
View a Patch Operation Status: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/applied/job/{jobId}
View All Applied Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/applied
View All Available Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/available
View Status of a Patching Precheck Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/checks/job/{jobId}
View Status of All Patching Precheck Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/checks

SSH Keys

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

Add an SSH Public Key: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/credentials/crednames/{credentialName}
View an SSH Key's Details: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/credentials/{credentialName}
View an SSH Key's Summary: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/credentials/crednames/{credentialName}
View Selected SSH Keys' Details: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/credentials
View Selected SSH Keys' Summaries: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/credentials/crednames

Service Instances

Create and manage MySQL Cloud Service instances.

Add Storage to a Service instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/storage/add
Create a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances
Delete a Service Instance: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}
Scale a Service instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/hosts/scale
Start, Stop, or Restart a Service Instance: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/hosts/{function}
View a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}
View All Service Instances: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances
View Tags for a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/tags

Snapshots

Create and manage snapshots of MySQL Cloud Service instances.

Create a Snapshot: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/snapshots
Delete a Snapshot: Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/snapshots/{snapshotName}
View a Snapshot: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/snapshots/{snapshotName}
View All Snapshots: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/snapshots

Tags and Tag 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