"Legacy" API endpoints used for managing applications and API clients (including both application and client settings). Although still supported, we recommend that you use the Configuration API's Clients and Settings endpoints instead.
In addition to reference information for each endpoint, this section of the documentation includes the following articles:
API Clients
| Endpoint | Methods |
|---|---|
List Your API Clients/clients/listView information about your API clients. |
|
Modify API Client Features/clients/set_featuresModify the features of an API client. Features determine the permissions available to a client; for example, the login_client feature enables a client to be employed in user logins and registrations. |
|
Reset an API Client Client Secret/clients/reset_secretReset the client secret for an API client. |
|
Rename an API Client/clients/set_descriptionChange the name (i.e., the description) of an API client. |
|
Create an API Client/clients/addCreate an API Client. |
|
Delete an API Client/clients/deleteRemove an API client. |
|
Modify an API Client IP Allow List/clients/set_whitelistUpdate the allow list for an API client. The allow list specifies the IP addresses that can make API calls using the client. |
|
Delete an API Client Allow List/clients/clear_whitelistClear the IP allow list for an API client. The allow list specifies the IP addresses that can make API calls using the client. |
|
Application and Client Settings
| Endpoint | Methods |
|---|---|
View an Application Setting/settings/get_defaultView the value of an application key. |
|
Modify an Application Setting/settings/set_defaultUpdate an application key. |
|
Modify Multiple Application Settings/settings/set_default_multiAssign multiple keys to an application. |
|
Delete an Application Setting/settings/delete_defaultDelete an application key. |
|
List Your Client Settings/settings/keysView all the keys assigned to an API client. |
|
View an API Client Setting/settings/getView the specified key value for an API client. |
|
Delete an API Client Setting/settings/deleteDelete an API client key. |
|
Modify a Client Setting/settings/setAssign a key-value pair to an application. |
|
View Multiple Client Settings/settings/get_multiView multiple keys and key values for an API client. |
|
Modify Multiple Client Settings/settings/set_multiAssign multiple settings to an API client. |
|
View Multiple Client Setting Values/settings/itemsView all the client settings for an API client. |
|
Published Settings
| Endpoint | Methods |
|---|---|
View Published Settings for an Application/settings/widget/listView your published settings files. |
|
View Published Settings for an API Client/settings/widget/getView the published settings for an API client. |
|
Publish Client Settings/settings/widget/publishPublish settings to a JSON file. |
|
Delete Published Client Settings/settings/widget/deleteRemove the published settings for an API client. |
|