AS216394 · WireShield

Documentation

Setup, connection and day-to-day operations guides.

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.

APIForToken is made inReference
DDoS Customer APICustomers of DDoS Protection and WireShield Edge: protection status, attacks, traffic, reports, your own lists and rulesThe DDoS portal, menu API tokensCustomer API
DDoS MSSP APIPartners that run DDoS protection for their own customersThe MSSP console, menu API tokensMSSP API
WAF Customer APICustomers of Web Protection: your own sites, origin servers, challenge and WAF switchThe WAF panel, API SettingsWAF Customer API
WAF Reseller APIPartners that resell Web Protection: customers, plans, sites, usage, wsCAPTCHAThe WAF reseller panel, API Settings (reseller accounts are issued by us on request)WAF Reseller API
wsCAPTCHAAny website with formsSite key and secret in WS Portal, wsCAPTCHAIntegration 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.
Still have a question about this guide?
Ask our technical team