OverviewCopy link to clipboard
The Connected System Management REST API provides programmatic access to Appian so you can automate configuration steps as part of your DevOps process.
This API lets you change connected system properties, like usernames and passwords, without needing to sign in and manually update those values.
This page explains how to call the API and how to authenticate those requests.
VersioningCopy link to clipboard
The Connected System Management REST API is currently at v1.
EndpointsCopy link to clipboard
There is one endpoint available for managing system data:
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
.
AuthenticationCopy link to clipboard
You authenticate client requests to the API with an API key or an OAuth token, either of which can be configured by an administrator in the Admin Console.
Using an API keyCopy link to clipboard
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/connected-system-management/v1/connected-systems/<UUID>' \
--header 'appian-api-key: <API key>' \
Copy
Using an OAuth tokenCopy link to clipboard
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/connected-system-management/v1/connected-systems/<UUID>' \
--header 'Bearer <token>' \
Copy