REST APIs for Oracle Database

All REST Endpoints

Rapid Home Provisioning/Manage Gold Images

You can create gold images and series to manage your deployments.

Add a new image series: Method: post
Path: /rhp-restapi/rhp/series/{seriesId}
Add image to series: Method: post
Path: /rhp-restapi/rhp/series/{seriesId}/images/{imageId}
Delete image series: Method: delete
Path: /rhp-restapi/rhp/series/{seriesId}
Deletes the specified image name: Method: delete
Path: /rhp-restapi/rhp/images/{imageId}
Display the configuration of the specified image: Method: get
Path: /rhp-restapi/rhp/images/{imageId}
Get all the series: Method: get
Path: /rhp-restapi/rhp/series
Get image series: Method: get
Path: /rhp-restapi/rhp/series/{seriesId}
Lists all the gold images: Method: get
Path: /rhp-restapi/rhp/images
Lists all the gold images that matches the specified query parameters.: Method: get
Path: /rhp-restapi/rhp/images/search
Remove image from series: Method: delete
Path: /rhp-restapi/rhp/series/{seriesId}/images/{imageId}
Schedules an import image operation: Method: post
Path: /rhp-restapi/rhp/images
Search series matching certain parameters: Method: get
Path: /rhp-restapi/rhp/series/search
Subscribe a user to a series: Method: post
Path: /rhp-restapi/rhp/series/{seriesId}/users/{userId}
Unsubscribe a user from a series: Method: delete
Path: /rhp-restapi/rhp/series/{seriesId}/users/{userId}

Rapid Home Provisioning/Manage Operation Results

You can verify the status and retrieve the output messages of any operation that creates a job to handle its scheduled execution like imaging, provisioning, upgrade and patching operations of software homes.

Get all the jobs: Method: get
Path: /rhp-restapi/rhp/jobs
Get job details: Method: get
Path: /rhp-restapi/rhp/jobs/{jobId}
Get the job output and result: Method: get
Path: /rhp-restapi/rhp/jobs/{jobId}/output

Rapid Home Provisioning/Patch Software homes

You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher patch level.

Patch an Oracle Database Software home: Method: patch
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}/databases
Patch Grid Infrastructure Software home: Method: patch
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}

Rapid Home Provisioning/Patch Unmanaged Software Homes

You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher patch level than the first software home.

Patch an unmanaged Oracle Database Software home: Method: patch
Path: /rhp-restapi/rhp/databases
Patch unmanaged Grid Infrastructure Software home: Method: patch
Path: /rhp-restapi/rhp/gihome/{destWcId}

Rapid Home Provisioning/Provisioning Software homes

You can provision a working copy of a gold image.

Create Oracle Database Software: Method: post
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}/databases
Create working copy: Method: post
Path: /rhp-restapi/rhp/workingcopies
Get all working copies: Method: get
Path: /rhp-restapi/rhp/workingcopies
Get working copies based on a certain image type: Method: get
Path: /rhp-restapi/rhp/workingcopies/imagetypes/{imageType}
Get working copy details: Method: get
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}
Search working copies: Method: get
Path: /rhp-restapi/rhp/workingcopies/search

Rapid Home Provisioning/Upgrade Software homes

You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher version.

Upgrade an Oracle Database Software home: Method: put
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}/databases/{dbUniqueName}
Upgrade Grid Infrastructure Software home: Method: put
Path: /rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}

Rapid Home Provisioning/Upgrade Unmanaged Software Homes

You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher version level than the first software home.

Upgrade an unmanaged Oracle Database Software home: Method: put
Path: /rhp-restapi/rhp/databases/{dbUniqueName}
Upgrade unmanaged Grid Infrastructure Software home: Method: put
Path: /rhp-restapi/rhp/gihome/{destWcId}