API Documentation
Heads up: our API is still in beta
Related: we offer Webhooks too.
You can create a new API key in your org settings. The key can then be used to access your account by using API endpoints under https://api.fluxguard.com
. Add your API key as the x-api-key
header of your request.
Data returned from the API call, if any, will always be in JSON format. API keys can be removed at any time in org settings, and then will no longer function.
Suppose your API key is abcdef123456
, then from a shell you can execute the following to access general information about your Fluxguard org:
curl -H 'x-api-key: abcdef123456' https://api.fluxguard.com/account
For endpoints that require parameters, attach form data in JSON format:
curl -H 'x-api-key: abcdef123456' -d '{"url":"https://example.org/"}'
https://api.fluxguard.com/add-page
General
Monitoring
Webhooks
Webhooks allow you to set up instant custom notifications about monitored pages. See our tutorial.
Categories
Sites can be put it into one or more categories, which can be customized to your needs. Note that the API as of now only supports creating site categories.