Getting Started with Curiefense
Deployment in Depth
Policies & Rules
Services and Container Images
The Challenge Process
Multi-Stage Traffic Filtering
Selecting the API option in the left sidebar will open the window shown above (by default, at
This displays the API visually using
. For production use,
can be used; sample curl calls for the various endpoints are available within Swagger.
, Curiefense's data is stored within:
A Configuration is a set of Blobs and Documents. A Document is a set of Entries.
All of these data structures can be edited via API:
A Document is a file treated as a JSON list of entries.
An entry is a JSON dictionary with an
field value must be unique inside the document, and must be a valid part of an URL.
A Blob is a file treated as binary data.
Each time a Configuration is modified, a new version is created. A Configuration can be
reverted back to a previous version at any time
The Curiefense API has the following namespaces:
(for manipulating Configurations)
(for accessing persistent key value storage)
(for publishing, etc.)
Each namespace contains various endpoints. For example,
Exploring the API
Swagger is a useful way to experiment with the API. For example, selecting
will display a list of endpoints. If you select this one:
... and then select the
Try it out
button, followed by the
button, this will be the result:
This allows you to interact with the API, try different commands, and see what responses will be generated.
As shown in the example above, Swagger will include sample curl commands for each namespace and endpoint. The commands can be copied and pasted for use elsewhere.
For some endpoints, arguments need to be supplied. Swagger will create defaults/samples, and provide input controls for them, as in this example:
Here a sample payload has been created, and is being displayed for editing. After it is edited, selecting the
button will display the responses that are generated.
Settings - Previous
Export as PDF
Exploring the API