...
...
Method | Description | |||||
---|---|---|---|---|---|---|
GET | Retrieves records from the Controller database. | |||||
POST | Creates, or performs an action on, a record in the Controller database. | |||||
PUT | Modifies a record in the Controller database.
| |||||
DELETE | Deletes a record in the Controller database. |
Authentication
Universal Controller requires Web Service requests to be authenticated using one of Basic Authentication or Personal Access Token Authentication.
For Basic Authentication, use the following Authorization header, where the username:password is base64 encoded.
Access to the Controller requires basic HTTP authentication over HTTPS.
The following methods are used:
...
Panel |
---|
|
For Personal Access Token Authentication, use the following Authorization header.
Panel |
---|
|
While it is recommended you use the Authorization header, if required, you can alternatively pass the Personal Access Token using the access_token query parameter.
Panel |
---|
http://hostname:port/uc/resources/task?access_token=access-token&taskname=MyTask |
Request Limits
You can implement application- and user-level concurrent request limits to control how many web service API requests can be in progress at the same time via the following Universal Controller system properties:
Web Service Application Concurrent Request Limit | Controls the number of concurrent requests for the application (that is, the Universal Controller server). This application-level concurrent request limit cannot be less than 1 or less than the user-level concurrent request limit (if specified). |
Web Service User Concurrent Request Limit | Controls the number of concurrent requests per unique user ID. This user-level concurrent request limit cannot be less than 1 or more than the application-level concurrent request limit (if specified). If the application-level concurrent request limit is exceeded, an HTTP Status of 429 /Too Many Requests will be returned. |
...
If either restriction is in place, the following error message will be written to the Audits table and the opswise.log file when you attempt to access the RESTful Web Services API:
Panel |
---|
User <your user name> not permitted to use Web Services. Please check with your administrator. |
To remove the restriction, the system administrator must either:
...