Using the Secrets Vault API Documentation

The online API documentation is integrated with the webGUI. You can access this at https://<KeyControl_IP>/apidoc/.

The following sections are used for the secrets vault: 

• Vault Group Management—Allows you to list, create, and delete a vault group, and retrieve or edit vault group details.
• Vault Secret—Allows you to list all secrets in a box, update the secret value, checkout the current or a specified secret value, add, update, or remove tags for a secret, and update the properties of a secret.
• Vault Box—Allows you to create or delete a box, list box IDs or all boxes in the vault, list or update box properties, and add, update, or remove tags,
• Vault Policy—Allows you to create, update, or delete a vault policy, list all vault policies or specific vault policy details, and list all vault policy versions.
• Vault Lease—Allows you to delete leases, retrieve lease attributes, list all leases, list specific leases by secret name or ID, and list lease checkouts.
• Vault AD—Allows you to retrieve the vault AD settings, list all vault AD settings, and update AD settings.
• Vault Audit—Allows you to list all the vault audit messages and message templates, retrieve specific audit message template details, and retrieve and update vault audit log settings.
• Vault Auth—After you create a vault in the webGUI, use the vault login API to supply your authorization credentials. If successful, the API returns an auth token to be used in all other APIs.