On this page:
On this page:
This page provides general usage information for the APIs.
Except as indicated in the format listing for a particular method, URIs in the Controller API use the following base URI:
The port that serves the API is the same primary port for the Controller used by Controller UI and agents.
Any Controller API with a URI in the /controller/rest/ format shown in Controller API Base URI can return data in JSON format.
To retrieve data in JSON, call the API with the output query parameter set to JSON, as follows:
For any of the Controller APIs, you can similarly specify JSON output format for the response.
When a client uses HTTP 1.1 and accepts gzip content encoding, the Controller returns JSON responses using gzip compression.
To invoke the REST APIs, provide basic HTTP authentication credentials as well as your account information. These are:
Pass the credentials in the following form:
For a single-tenant Controller (which is the case for most on-premises Controllers), the account name should be the account name for the primary default account, which is "customer1". For example:
If you are using a multi-tenant Controller (most SaaS Controllers), replace customer1 with your own, instance-specific account name. You can find the account name in the License Management page.
Usernames that contain the following characters are not authenticated for REST API calls:
If you have already created usernames that contain any of the disallowed characters, such as "user:customer66", create a new username without the disallowed chartacter for the purpose of accessing the REST APIs.
For usernames containing the "@" symbol, URL encode the "@" character as %40.