API Access

Access to the API information is controlled in the following ways. API calls are charged to the account holder.
cacm82
Access to the API information is controlled in the following ways. API calls are charged to the account holder.
 
 
API Calls and Credits
Each API call has a credit price (API credits). The credit amount per day depends on your subscription. To see the price for each call, go to the API and click the orange operations. The price of each call is above the fill-in box.
The types of credits are :
  • API credits: Use for API calls
  • SMS credits: Use with the ch_send SMS operation
  • Check credits: Use to test ASM monitoring stations (checkpoints), for example, rule_check, and cp_check
Anonymous Access
Several calls support Anonymous Access with limited resources:
  • Session keys (nkeys) are created per-IP
  • Anonymous sessions are limited to 50 API credits per day
Authenticated Access
Authenticated access calls can manipulate your data and settings. The number of access calls available depends on your subscription.
  • To access with authentication, call the 
    acct_login
     with your credentials and obtain an account nkey
     
     
  • Use the nkey for future calls
  • Call 
    acct_logout
     to destroy the session and invalidate the key
Session Bounds and Lifetime
  • A session is 15 minutes long. You can extend the session lifetime by calling acct_noop
  • An nkey is connected to an IP address
  • An nkey parameter value can be sent in a GET, POST or a COOKIE
Browser API Access
You can use your browser to test and debug API calls. To make browser calls, go to the API endpoint URL and perform the calls from the forms.
  • You can make browser account mode access calls
  • nkeys are stored in browser cookies and picked up by the calls automatically
Access Data from Other Accounts
DX APP Synthetic Monitor
 supports sub-accounts (children accounts of a master account). Master accounts have privileges to access and manipulate data belonging to their sub-accounts:
  • Account owners have access to all sub-accounts
  • Reseller accounts have access to all client accounts
  • Account owners can authorize access for sub-accounts to monitors in a specific folder
  • Account owners can authorize read-only access for sub-accounts to monitors in a specific folder
To access or edit monitors, contacts, and, folders, a minimum of one of the following conditions must apply:
  • You are the owner of the account that created the monitors
  • You are the parent or reseller of the sub-account that created the monitors
  • Your parent account gives you read-only or write access to a folder with monitors