API usage

Access the online documentation

CISO Assistant API Documentationca-api-doc.pages.dev

Enable the documentation locally

Enable debug mode

export DJANGO_DEBUG=True

Start the backend server (make sure that dependencies are installed):

python3 manage.py runserver

Access the swagger documentation here:

http://127.0.0.1:8000/api/schema/swagger/

Or redoc format here:

http://127.0.0.1:8000/api/schema/redoc/127.0.0.1

Interacting with the API

• Start by creating a PAT, instructions hereGenerating a PAT

• Use this token to form your Authorization header, it needs to be as follows:

Authorization: Token <your_token>

Then you can use with any rest client or within your application or script:

Example with Bruno (Postman alternative)

Or with curl:

curl --request GET \
  --url http://127.0.0.1:8000/api/assets/ \
  --header 'authorization: Token a6a120f....'

Notes

• make sure to add the trailing slash '/'

• your endpoint is your instance URL. If the proxy settings are the default ones, it will be the same url but with /api/ (in which case you don't need to add it)

• Pro SaaS users need to open a support request to expose the API on their instance. It's disabled by default.