Legacy Clients and Settings API

"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

EndpointMethods

List Your API Clients

/clients/list
View information about your API clients.
  • POST

Modify API Client Features

/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.
  • POST

Reset an API Client Client Secret

/clients/reset_secret
Reset the client secret for an API client.
  • POST

Rename an API Client

/clients/set_description
Change the name (i.e., the description) of an API client.
  • POST

Create an API Client

/clients/add     
Create an API Client.
  • POST

Delete an API Client

/clients/delete
Remove an API client.
  • POST

Modify an API Client IP Allow List

/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.
  • POST

Delete an API Client Allow List

/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.
  • POST




Application and Client Settings

EndpointMethods

View an Application Setting

/settings/get_default
View the value of an application key.
  • POST

Modify an Application Setting

/settings/set_default
Update an application key.
  • POST

Modify Multiple Application Settings

/settings/set_default_multi
Assign multiple keys to an application.
  • POST

Delete an Application Setting

/settings/delete_default
Delete an application key.
  • POST

List Your Client Settings

/settings/keys
View all the keys assigned to an API client.
  • POST

View an API Client Setting

/settings/get
View the specified key value for an API client.
  • POST

Delete an API Client Setting

/settings/delete
Delete an API client key.
  • POST

Modify a Client Setting

/settings/set
Assign a key-value pair to an application.
  • POST

View Multiple Client Settings

/settings/get_multi
View multiple keys and key values for an API client.
  • POST

Modify Multiple Client Settings

/settings/set_multi
Assign multiple settings to an API client.
  • POST

View Multiple Client Setting Values

/settings/items
View all the client settings for an API client.
  • POST




Published Settings

EndpointMethods

View Published Settings for an Application

/settings/widget/list
View your published settings files.
  • POST

View Published Settings for an API Client

/settings/widget/get
View the published settings for an API client.
  • POST

Publish Client Settings

/settings/widget/publish
Publish settings to a JSON file.
  • POST

Delete Published Client Settings

/settings/widget/delete
Remove the published settings for an API client.
  • POST