"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:
Endpoint | Methods |
---|---|
/clients/add Create an API Client. |
|
/clients/clear_whitelist Clear the IP allow list for an API client. The allow list specifies the IP addresses that can make API calls using the client. |
|
/clients/delete Remove an API client. |
|
/clients/list View information about your API clients. |
|
/clients/reset_secret Reset the client secret for an API client. |
|
/clients/set_description Change the name (i.e., the description) of an API client. |
|
/clients/set_features Modify 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. |
|
/clients/set_whitelist Update the allow list for an API client. The allow list specifies the IP addresses that can make API calls using the client. |
|
/settings/delete Delete an API client key. |
|
/settings/delete_default Delete an application key. |
|
/settings/get View the specified key value for an API client. |
|
/settings/get_default View the value of an application key. |
|
/settings/get_multi View multiple keys and key values for an API client. |
|
/settings/items View all the client settings for an API client. |
|
/settings/keys View all the keys assigned to an API client. |
|
/settings/set Assign a key-value pair to an application. |
|
/settings/set_default Update an application key. |
|
/settings/set_default_multi Assign multiple keys to an application. |
|
/settings/set_multi Assign multiple settings to an API client. |
|
/settings/widget/delete Remove the published settings for an API client. |
|
/settings/widget/get View the published settings for an API client. |
|
/settings/widget/list View your published settings files. |
|
/settings/widget/publish Publish settings to a JSON file. |
|