skip to main content
Using the DataDirect Cloud Management APIs
 

Try DataDirect Cloud Now

Using the DataDirect Cloud Management APIs

DataDirect Cloud provides a representational state transfer (REST) application programming interface (API) for managing DataDirect Cloud connectivity service resources. Some examples of managed resources are data sources and On-Premise Connector access control lists (ACLs).
The DataDirect Cloud Management API is comprised of the User Provisioning API, the Connector API and the DataSource API. Any DataDirect Cloud user can use these APIs to manage user accounts, entitlements, and data sources.

Overview

To execute an operation using the API, you need to submit an HTTP POST, GET, PUT, or DELETE request to the URL that corresponds to the operation that you want to perform. Each URL includes variables that identify your domain and, possibly, the resource that you are creating, retrieving, updating or deleting.
A DataDirect Cloud REST URL for the Management API consists of the following components:
<base>/<resource>[/<resource_specific_parts>]
where
<base>
is the host name of the service the REST request is directed to.
For this release, <base> is https://service.datadirectcloud.com/api/mgmt.
<resource>
is the resource that is being fetched, created, modified or deleted. For example, users and data sources are both resources.
<resource_specific_parts>
are portions of the URL that can optionally be specified, depending on the resource specified in the URL.
For example, to get the list of the names of all user-defined data sources, you specify:
https://service.datadirectcloud.com/api/mgmt/datasources
For more information about how Progress Partners access and use APIs, watch a video.

Supported APIs

The following table briefly describes the DataDirect Cloud Management APIs.
API Name
URL
Description
https://service.datadirectcloud.com/api/mgmt/connectors
Allows users to:
*Get information about On-Premise Connectors they own and update the display name of each Connector
*Create, view, update, and delete data source groups
*Configure load balancing for data sources
https://service.datadirectcloud.com/api/mgmt/datastores
Provides information on:
*What Data Stores are available in DataDirect Cloud
*Whether a user is entitled to use a specific data store
https://service.datadirectcloud.com/api/mgmt/datasources
*Allows a user to create, view, update, and delete data sources
*Allows a user to create, view, update, and delete data source groups
*Allows an administrator to enable users to get the information for the schema map editor that they will be implementing
https://service.datadirectcloud.com/api/mgmt/oauthapps
https://service.datadirectcloud.com/api/mgmt/oauthprofiles
*Allows a user to create, view, update, and delete OAuthApplications
*Allows a user to create, view, update, and delete OAuthProfiles
https://service.datadirectcloud.com/api/mgmt/users
Allows an OEM Administrator to
*Create, view, update and delete OEM End User accounts
*Change or invalidate a user's password

Compatibility Note

Future versions of the Management API may add additional properties, arrays or objects to response payloads. To ensure maximum compatibility with future versions, calling applications should be coded to ignore elements that they do not recognize.
For example, suppose an application contains an endpoint foo that returns a response that looks like the following code snippet:
{
"accountName":"test",
"type":"individual",
"status":"active"
}
At a later time, the response is modified to add creationDate and lastModifiedDate.
{
"accountName":"test",
"type":"individual",
"status":"active",
"creationDate":"2015-01-01 01:01:01",
"lastModifiedDate":"2005-02-24 02:02:02"
}
Code to parse the response that was written to look for the original accountName, type, and status properties, will continue to work with the new response. However, the applications just would not take advantage of the new information.