REST API for Oracle Session Delivery Management Cloud

All REST Endpoints

Network function APIs

The operations from the Network function APIs category.

Add an NF: Method: post
Path: /rest/{versionId}/inventory/nf-mgmt/nfs
Delete a Network Function: Method: delete
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}
Get a Targeted NF: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}
Get List of NFs in Device Management: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nfs
Get NF Device Groups: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}/groups
Lock or unlock a Network Function: Method: post
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/action/{nfId}
Move an NF to Another Device Group Parent: Method: put
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}
Updates the device group in a Network Function (NF): Method: put
Path: /rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}/groups/{groupId}

User Management APIs

The operations from the User Management APIs category.

Downloads Audit Logs: Method: get
Path: /rest/{versionId}/security/audit-logs

admin

administration APIs

Deletes user permissions cache: Method: delete
Path: /rest/{versionId}/admin/permissions-cache

configuration/devices

device configuration APIs

Assign a Device to Element Manager for FCAPS Management: Method: post
Path: /rest/{versionId}/configuration/devices
Get a List of Devices Associated with Config Manager: Method: get
Path: /rest/{versionId}/configuration/devices
Get Device Configuration Management Summary Information: Method: get
Path: /rest/{versionId}/configuration/devices/{deviceId}
Load a Configuration for a Targeted Device: Method: get
Path: /rest/{versionId}/configuration/devices/{deviceId}/load-config
Unassign a Device from Element Manager to Stop FCAPS Management: Method: delete
Path: /rest/{versionId}/configuration/devices/{deviceId}
Update the Configuration on a Device: Method: post
Path: /rest/{versionId}/configuration/devices/{deviceId}/action

device configuration

Device configuration APIs

Add a Configuration Element: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/add
Create a Configuration Element: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/create
Delete a Configuration Element: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/delete
Delete Pending Configuration Modifications: Method: delete
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/configuration-changes
Get a Configuration Element Instance: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/retrieve
Get a List of Configuration Element Instances: Method: get
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements
Get a List of Top-level Configuration Element Types: Method: get
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/element-types
Get Additional Attribute Metadata: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/element-types/attribute-metadata
Get Additional Element Metadata: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/element-types/element-metadata
Get Pending Configuration Modifications: Method: get
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/configuration-changes
Update a Configuration Element: Method: post
Path: /rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/update
Update a Configuration Password: Method: post
Path: /rest/{versionId}/configuration/device-configs/util/encrypt-password

inventory/device

device management APIs

Get Device Information: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/devices/{deviceId}
Get Device Management Summary Information: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/devices
Overrides lock on device: Method: post
Path: /rest/{versionId}/inventory/device-mgmt/devices/{deviceId}/groups/{groupId}

inventory/device-groups

Device group APIs.

Add a Device Group: Method: post
Path: /rest/{versionId}/inventory/device-mgmt/device-groups
Delete a Device Group: Method: delete
Path: /rest/{versionId}/inventory/device-mgmt/device-groups/{groupId}
Get Device Group Information: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/device-groups/{groupId}
Get Existing Device Groups: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/device-groups
Update a Device Group: Method: put
Path: /rest/{versionId}/inventory/device-mgmt/device-groups/{groupId}

inventory/sites

The operations from the inventory/sites category.

Adds a site: Method: post
Path: /rest/{versionId}/inventory/device-mgmt/sites
Assign sites: Method: post
Path: /rest/{versionId}/inventory/device-mgmt/sites/{managingSiteId}/assign
Delete a Site: Method: delete
Path: /rest/{versionId}/inventory/device-mgmt/sites/{siteId}
Retrieve assigned Sites detail for a Managing Site.: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/sites/{managingSiteId}/assign
Retrieve Site details by Site name: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/sites/{siteName}
Retrieves all Sites: Method: get
Path: /rest/{versionId}/inventory/device-mgmt/sites
Update Site details by Site Id: Method: put
Path: /rest/{versionId}/inventory/device-mgmt/sites

network function category

administration APIs

Get a Targeted Category: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}
Get Additional Category Metadata: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}/nf-types
Get Additional NF Metadata: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}/nf-types/{nfTypeName}
Get NF Supported product Categories: Method: get
Path: /rest/{versionId}/inventory/nf-mgmt/nf-categories