Account Config

API version3.1
Last Update10/22/2019
AuthenticationYES
Response FormatJSON
HTTP MethodPOST
Rate limitedYES
Requests per rate limit10/min
Change History10/22/2019: add new regcode section

Use this API to retrieve account settings.

API URL

Copy

Request Parameters

KeyDatatypeParameter TypeRequiredDescriptionDefault
access_tokenstringURLYesaccess token which archived from OAuth authentication step
sectionsArray of stringsBodyYes

Specify which settings to fetch information. Available options:

  • cross-domain-api: Cross-domain API setting
  • regcode: a registration code for mobile devices to enroll to the account

Response HTTP Code

See details in the Response HTTP Code section in this page

Response Parameters

KeyDatatypeDescription
<setting_name>object

a setting name in the request.

Depend on settings, object will have different keys in response

cross-domain-apiobjectCross-domain API setting
cross-domain-api.enablednumber

Values:

  • 1: API is enable on endpoints at the configured port
  • 0: API is disable on endpoints
cross-domain-api.portnumberport number which the cross-domain API is listening on endpoints
regcodestringAccount specific registration Shortcode

Example

Request Example

Copy

Response Example

Copy

History

ActionVersionURL
Account Config3.0auto$
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Account Details
On This Page
Account ConfigAPI URLRequest ParametersResponse HTTP CodeResponse ParametersExampleHistory