API: HTTP Get Realm Settings
The Get Realm Settings command allows you to return a list of settings that indicate which features are enabled for a realm.
Arguments
Show Get Realm Settings requires the following arguments: Command, Realm, and Password.
api_web?r=myrealm&p=mypass&c=getrealmsettings
The command is ‘getrealmsettings’, the realm is ‘myrealm’ and the password is ‘mypass’.
The Get Realm Settings command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd= getrealmsettings c= getrealmsettings |
|
Realm |
Yes |
Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match. |
realm=[realm_name] r=[realm_name] |
|
Password |
Yes |
Authentication code for API access. This is required, and the command will fail if the realm and password do not match. |
pwd=[password] p=[password] |
|
Output Format |
|
To specify the format of the list output, use one of two arguments. If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.
|
csv=1 or output_format=[csv,csv_tab, csv_pipe,xml] |
|
Header |
To define the data with a label, use the Header argument. This can only be used in conjunction with the output format, and does not affect XML. |
headers=[0,1] DEFAULT==0 |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?r=myrealm&p=mypass&c=getrealmsettings&output_format=csv&headers=1
Successful results return the following details for the realm:
"realm_id","use_customer_key","enable_relational_database" "1","N","Y"
The results indicate that the realm does not use the Customer Key to identify contacts, but the realm is allowed to use Relational data tables.
Results
The Get Realm Settings command outputs either the results of the search or a FAILURE message.
SUCCESS
The Get Realm Settings command does not explicitly return a Success code. Instead, it outputs the realm ID, customer key setting, and relational database setting in plain text format. Use the output_format argument to return the results in an alternate format.
FAILURE
A Get Realm Settings command will fail for several reasons. The result format is:
FAILURE: [Reason]