Home / Help centre / Integrations & API
Integrations & API
How do I check that my key vault connection works?
Press Verify on the key vault tab of Integrations before you press Save. It tests the service principal you typed. Scripts can call POST /api/keyvault/verify instead, which also checks named secrets and needs the profile:manage_credentials permission.
Steps
- Go to Integrations and open the key vault tab.
- Fill in Name, Tenant ID, Client ID and Client secret.
- Select Verify. Cyberlop tries the service principal against your vault.
- Read what comes back. If it reports a problem, correct the field it points to and verify again.
- When the check passes, press Save.
Good to know
Verify first, save second. A typo in the client secret or a wrong tenant is far easier to spot before you store the connection than after a scan fails to read a credential.
Once you save, the client secret never shows again. To re-test later, you may need to type the secret in again, so keep it in a place your team trusts.
The API offers two routes for the same check, and they differ in who may use them.
| Route | Permission | What it checks |
|---|---|---|
POST /api/keyvault/verify | profile:manage_credentials | The vault connection and named secrets |
POST /api/settings/verify-keyvault | settings:update | The service principal |
The exact wording of a success or failure message appears in the app, so read it there. If a message stays unclear, send it to us through the contact page with the time you tried.
First time here? Read how to connect your cloud key vault. The reasons teams use a vault are in what a key vault is for.
Related questions
- How do I connect my cloud key vault?
- What is the cloud key vault integration used for?
- Why does my API call return a permission error?
- How do I find the endpoint I need and the permission it requires?
- How do I authenticate requests to the Cyberlop API?
How to connect a cloud key vault to Cyberlop
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Wiring it into your pipeline?
Share what you are building and we will help you set up the right token, profile and job.