API

navigate to the sidebar menu integrations docid\ dqci75yzybykvzlfcbztl > api overview the api module is designed to manage programmatic access to your dashboard it allows developers and system administrators to securely connect custom applications, automate repetitive tasks, and extract data using our application programming interface how it works the system generates a unique authentication key tied to your specific administrative user and role by utilizing this key , external scripts and services can interact with the platform securely without requiring manual login via the web interface interface overview the interface features an informational banner containing helpful resources , followed by a detailed list of your available api credentials documentation banner use this top section to access detailed technical resources interface element description & focus consult the api documentation an informational banner providing a direct link to the comprehensive developer documentation , featuring technical details and usage examples you can dismiss this banner by checking the don't show again box list view the main table displays your active api keys and their usage statistics interface element description & focus username & key displays the name of the administrator above their unique alphanumeric api credential click the copy button to securely copy the text to your clipboard status a label indicating whether the api key is currently active and ready to authenticate requests role shows the specific permission level associated with the generated api key, ensuring programmatic actions are bound by role based access controls last used indicates the exact date the api key was most recently utilized to communicate with the system created on shows the original generation date of the api credential configuration & logicsecure automation api keys carry the exact same privileges as the user role they are assigned to safeguard these credentials carefully as they provide direct access to your platform configurations you can use these keys in conjunction with the official api documentation to automate policy deployments , synchronize network updates , or fetch security logs directly into your preferred monitoring systems