Which API is for you
Every WireShield service has its own API. They are kept in the console of the service, so a token you make there only opens that service. Your WS Portal has an API & Integrations page that shows the ones you can use and takes you to the right place to create a token.
| API | For | Token is made in | Reference |
|---|---|---|---|
| DDoS Customer API | Customers of DDoS Protection and WireShield Edge: protection status, attacks, traffic, reports, your own lists and rules | The DDoS portal, menu API tokens | Customer API |
| DDoS MSSP API | Partners that run DDoS protection for their own customers | The MSSP console, menu API tokens | MSSP API |
| WAF Customer API | Customers of Web Protection: your own sites, origin servers, challenge and WAF switch | The WAF panel, API Settings | WAF Customer API |
| WAF Reseller API | Partners that resell Web Protection: customers, plans, sites, usage, wsCAPTCHA | The WAF reseller panel, API Settings (reseller accounts are issued by us on request) | WAF Reseller API |
| wsCAPTCHA | Any website with forms | Site key and secret in WS Portal, wsCAPTCHA | Integration guide |
How tokens work
- A token is shown once, when you create it. Copy it into your password manager or server settings straight away.
- It works with the permissions of the account that made it. Create a read-only token when you only need to read.
- Send it in every request:
Authorization: Bearer <token>. - Revoke a token in the console where you made it. A token that leaked is revoked in seconds.
- Keep tokens on your servers. Never put one in browser code or a public repository.
Which one do I need?
- You want to read your attacks and traffic, or manage your own rules from a script: the DDoS Customer API.
- You run an MSSP and want to automate your customers: the DDoS MSSP API.
- You want to add sites to Web Protection from your own system: the WAF Customer API (one account) or the WAF Reseller API (many customers).
- You want to stop bots in a form: wsCAPTCHA, which needs only a key, not a token.