Rest API for Oracle PeopleSoft Cloud Manager

REST API in Cloud Manager facilitates you to automate the interaction with Cloud Manager, by-passing the Web User Interface. To perform REST operations, you must have the administrator role.

Using REST API, an administrator can perform the following operations:

  • Listing all created templates

  • Retrieve template information

Listing All Templates

Retrieve all the templates created in cloud manager

Method : GET

Path: /template.v1/

Retrieve Template Information

Retrieve details of the selected template.

Method: GET

Path: /template.v1/<templateId>

The list of environment management operations that can be performed using REST APIs are:

  • Create new environments

  • Create environment with Lifted DPK in Compute

  • Create environment with Lifted DPK in DBaaS

  • Delete created environments

  • Start environment

  • Stop environment

  • Snapshot environment

  • List all the environments created and their status.

  • List environment information

Creating New Environments

Provision new environments in Cloud Manager.

Note: Please ensure to create the required template prior to environment provisioning.

Method: POST

Path: /environment.v1/

Create Environment with Lifted DPK in Compute

Creates environment with lifted DPK in Compute.

Method: GET

Path: /environment.v1/

Create Environment with Lifted DPK in DBaaS

Creates environment with lifted DPK in DBaaS.

Method: GET

Path: /environment.v1/

Delete Environments

Deletes created environments.

Method: DELETE

Path: /environment.v1/<environmentID>

Response: Deleting Environment with EnvID:<envid>

Start Environment

Starts an environment.

Method: PUT

Path: /environment.v1/<env id>?action=start

Response: Staring Environment with environmentID:<envID>

Stop Environment

Stops an environment.

Method: PUT

Path: /environment.v1/<env id>?action=stop

Response: Stopping Environment with environmentID:<envid>

List Provisioned Environments

Lists all environments provisioned through the Cloud Manager accessible for the current user.

Method: GET

Path:  /environment.v1/

List Environment Information

Retrieves the details of environment provisioned through the Cloud Manager accessible for the current user.

Method: GET

Path: /environment.v1/<envid>

The list of repository management operations that can be performed using REST APIs are:

  • Create new channels

  • Subscribe to release channels

  • Unsubscribe from release channels

  • List all the available channels

  • List of subscribed channels

  • List of unsubscribed channels

  • Retrieve download status for channel

Create New Channels

Used to create new channels in repository.

Method: POST

Path: /channel.v1/

Response: Channel <channelName> created

Subscribe to Release Channels

Subscribes an already present unsubscribed channel.

Method: POST

Path: /subscribe.v1/

Response: <ChannelName> has been Subscribed

Unsubscribe from Release Channels

Unsubscribes an already present subscribed channel.

Method: DELETE

Path:/subscribe.v1/<channel  Name>

Response: Channel HCM_92_Linux has been Unsubscribed

List Channels in Repository

Retrieves list of the channels created.

Method: GET

Path:/channel.v1/

List of Subscribed Channels

Retrieves list of the channels created.

Method: GET

Path:/Channel.v1/?subscribed=true

List of Unsubscribed Channels

Retrieves list of unsubscribed channels.

Method: GET

Path:/channel.v1/?subscribed=false

Retrieve Status of Subscribed Channel

Retrieve the status of downloads for a subscribed channel. User can verify the downloads happening for this particular channel and also view all the completed downloads.

Method: GET

Path:/subscription.v1/<channelName>/downloads

The list of lift and shift management operations that can be performed using REST APIs are:

  • List DPKs uploaded in the object store

  • Retrieve DPK details

  • Retrieve Metadata from Object Store

  • Delete DPKs present in object Store

List DPKs

Retrieve the list DPKs that is stored in Object Store. This data is retrieved from metadata that is stored in Cloud Manager.

Method: POST

Path: /channel.v1/

Response: Channel <channelName> created

Retrieve DPK Details

Retrieves DPK details.

Method: GET

Path:/liftedobject.v1/<ObjectName>

Retrieve Metadata

Retrieves the metadata from object store and update the Cloud Manager data.

Method: GET

Path:subscribe.v1/?action=retrivemetadata

Response: Please wait while Cloud Manager retrieves the information from OPC.

Delete DPKs

Delete lifted DPKs from object store.

Method: DELETE

Path:subscribe.v1/

Response: Please wait while Cloud Manager Deletes from OPC.