Applications
Methods
AddApplication
Adds a new account's application.
To call this method, make sure your service account has one of the following roles:
Parameters
application_name:
string
The short application name in format [a-z][a-z0-9-]{1,64}
secure_record_storage:
boolean
OptionalWhether to enable secure storage for all logs and records of the application
Returns
application_id:
number
The application ID
application_name:
string
The full application name
result:
number
1
secure_record_storage:
boolean
Whether a secure storage for logs and records is enabled or not
DelApplication
Deletes the account's application.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
intlist
The application ID list separated by semicolons (;). Use the 'all' value to select all applications
application_name:
stringlist
The application name list separated by semicolons (;). Can be used instead of application_id
Returns
result:
number
1
GetApplications
Gets the account's applications.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
number
OptionalThe application ID to filter
application_name:
string
OptionalThe application name part to filter
count:
number
OptionalDefaults on: 20The max returning record count
offset:
number
OptionalDefaults on: 0The first N records are skipped in the output
with_rules:
boolean
OptionalDefaults on: falseWhether to get bound rules info
with_scenarios:
boolean
OptionalDefaults on: falseWhether to get bound rules and scenarios info
Returns
count:
number
The returned application count
result:
total_count:
number
The total found application count
SetApplicationInfo
Edits the account's application.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
number
The application ID
application_name:
string
OptionalThe new short application name in format [a-z][a-z0-9-]{1,79}
required_application_name:
string
The application name that can be used instead of application_id
secure_record_storage:
boolean
OptionalWhether to enable secure storage for all logs and records of the application
Returns
application_name:
string
The new full application name
result:
number
1
secure_record_storage:
boolean
Whether a secure storage for logs and records is enabled or not