API

Use ITFlow's API to work with ITFlow in scripts third-party applications.

The current version of the ITFlow API is v1. It can be accessed at itflow.example.com/api/v1/{module}/{function}.php

1. Login and navigate to the Admin Settings page
2. Select API Keys
3. Select Create to open the New Key modal
4. On Details tab, input the key name and expiration date. Select whether the key will allow access to all clients or a specific client
5. On Keys tab, note down the API key and credential password and select the checkbox to confirm you've made a copy of the keys. You will not see these admin in the admin interface.
6. Select Create to add the key into the database

• assets
• certificates
• clients
• contacts
• credentials (logins)
• domains
• networks
• software
• tickets

• read
• create (partial)
• update (partial)
• delete (partial)

• We may also add archive

• GET - Retrieving (READ) data
• POST - Inserting (CREATE), Updating (UPDATE) or Deleting (DELETE) data

• Success - True/False
• Message - Failure info / Helpful debug info
• Count - Count of rows affected/returned
• Data - The data requested/created/changed

• For read requests, 50 records are shown by default. This can be adjusted by supplying the limit and offset parameters.
• For POST requests, the client_id parameter is always required if the API key used has scope/access to all clients
• Be sure to check your Apache/PHP error logs if you're running into issues

Documentation / an example of how to use a module API endpoint is shown on that module's doc page. Additional examples are available here.