Support  ·  Your other tools

API keys

Make keys so scripts and other systems can open, read, and update tickets.

The API lets scripts and other systems work with tickets. A monitoring system can open a ticket when a server goes down, a PowerShell script can file one when a backup fails, and a Power BI report can read ticket numbers. Each one needs a key, made here.

Make a key

1. Give it a Name after what will use it (“Server monitoring”), so you know which one to revoke later.
2. Pick who it Acts as. The key sees and does exactly what that person can.
3. Tick It can open and change tickets if it needs to. Leave it off for something that only reads, like a report.
4. Click Make the key and copy it right away. It’s only shown once.

Make a separate person for the key under Settings, People (like “Monitoring”), with only the role it needs. That way its changes are easy to spot in ticket history, and it can’t do more than its job.

Only Super Admins can make a key that acts as someone other than themselves. A key stops working if whoever made it loses that right.

Use it

The How to use it box on the page lists every call, with PowerShell and curl examples. Changes made through a key show in the ticket’s history as the person it acts as, and the same routing rules, emails, and alerts happen as they would from the web.

Keep an eye on keys

The Keys list shows who each key acts as, whether it can write, and when it was last used. A key that hasn’t been used in a long time is a good one to revoke. Revoke stops a key at once. If a key is lost or might have leaked, revoke it and make a new one.