Cloud Database Management REST API

Overview

The Cloud Database Management REST API provides programmatic access to the Appian-provided Cloud database so you can automate configuration steps as part of your DevOps process.

With this API, you can manage various aspects of the cloud database, such as user credentials for the Enhanced Data Pipeline (EDP), without the need to log in and manually update those values.

This page explains how to make API calls and authenticate requests.

Endpoint

There is one endpoint available for managing the Appian-provided Cloud database: /cloud-database-management/v1/edp-credentials/<edp-username>.

The API's base URL is unique to your Appian environment. It is formatted as https://<environment hostname>/suite. For example, if your hostname is mysite.appiancloud.com, the base URL would be https://mysite.appiancloud.com/suite.

Learn how to update the enhanced data pipeline user credential programmatically.

Authentication

You authenticate client requests to the API with an API key or an OAuth token.

To use either of these authentication methods, your administrator must first configure the method in the Admin Console.

Using an API key

To use an API key to authenticate requests, set the appian-api-key header with the API key as the header value.

1
2
3
curl --location --request \
PATCH 'https://mysite.appiancloud.com/suite/cloud-database-management/v1/edp-credentials/<edp-username>' \
--header 'appian-api-key: <API key>' \

Using an OAuth token

To authenticate requests with an OAuth token, set the Authorization header with the Bearer prefix and token as the header value.

1
2
3
curl --location --request \
PATCH 'https://mysite.appiancloud.com/suite/cloud-database-management/v1/edp-credentials/<edp-username>' \
--header 'Bearer <token>' \

Feedback