The WebTitan Cloud Restful API allows authenticated administrators to on-board and manage customers and their locations, blacklists and whitelists. Authentication to the WebTitan Cloud API is provided via the OAuth 1.0 protocol.

If the API is being used you will need all of the above keys:

  • OAuth Consumer Key
  • OAuth Consumer Secret
  • OAuth Access Token
  • OAuth Access Token Secret

Below is an example of how the API can be used to create a customer account on the WebTitan Cloud Appliance.

Here are the parameters required when creating an account using Restful API.

The above POST will in turn create the following output.

We can see that the Customer Account was created successfully, and we are given a detailed list of the Customer Account information in a response.
Below is a table including all the possible actions we can take using the WebTitan Cloud Restful API.

Action Type
Create Customer Account POST http://webtitancloud.example.com:8080/restapi/users/
Register for OAuth POST http://webtitancloud.example.com:8080/restapi/auth/adminregister/
Delete Customer Account DELETE http://webtitancloud.example.com:8080/restapi/users/:id
Get Customer Account GET http://webtitancloud.example.com:8080/restapi/users/:id
List Customer Accounts GET http://webtitancloud.example.com:8080/restapi/users/
Update Customer Account POST http://webtitancloud.example.com:8080/restapi/users/:id
Create Customer Location POST http://webtitancloud.example.com:8080/restapi/users/:id/locations/
Delete Customer Location DELETE http://webtitancloud.example.com:8080/restapi/users/:id/locations/:locationid
Get a Location GET http://webtitancloud.example.com:8080/restapi/users/:id/locations/:locationid
List Customers Locations GET http://webtitancloud.example.com:8080/restapi/users/:id/locations
Update Customer Location POST http://webtitancloud.example.com:8080/restapi/users/:id/locations/:locationid
Create a Customer Blacklist POST http://webtitancloud.example.com:8080/restapi/users/:id/blacklist/
Delete Blacklist Entry DELETE http://webtitancloud.example.com:8080/restapi/users/:id/blacklist/:blacklistid
Get Blacklist Entry GET http://webtitancloud.example.com:8080/restapi/users/:id/blacklist/:blacklistid
List Customer Blacklists GET http://webtitancloud.example.com:8080/restapi/users/:id/blacklist/
Update Blacklist Entry POST http://webtitancloud.example.com:8080/restapi/users/:id/blacklist/:blacklistid
Create Whitelist Entry POST http://webtitancloud.example.com:8080/restapi/users/:id/whitelist/
Delete Whitelist Entry DELETE http://webtitancloud.example.com:8080/restapi/users/:id/whitelist/:whitelistid
Get Whitelist Entry GET http://webtitancloud.example.com:8080/restapi/users/:id/whitelist/:whitelistid
List Whitelist Entries GET http://webtitancloud.example.com:8080/restapi/users/:id/whitelist/
Update Whitelist Entry POST http://webtitancloud.example.com:8080/restapi/users/:id/whitelist/:whitelistid
Get Customer Cloud Keys GET http://webtitancloud.example.com:8080/restapi/users/:id/cloudkeys

For more a more detailed description of any of the above or a list of the required parameters, please consult the complete API document which is available at http://apidoc.webtitancloud.com.

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Post Comment