Getting Started

Use the API Explorer on the right to discover and explore our API. You will need to create an account and obtain an API key to access the API. Once you have your API key, you can start using the API to automate your compliance and regulatory workflows. You can also use the API to integrate with your existing systems and workflows.

To use the API, you will need to make HTTP requests to our API endpoints. You can use any programming language or tool that supports HTTP requests to interact with our API:

curl -X GET "https://app.devguard.ch/api/assets/?organizationId=UUID" \
  -H "Authorization: Bearer dvg_your_token_here" \
  -H "Content-Type: application/json"

If you have any questions or need assistance, please contact our support within our application.

The API or the CLI?

The API is for building: anything your systems need to read or write in devguard, they can do over HTTP. The CLI is a finished tool for the most common automation, keeping evidence current from a pipeline. It runs the checks you declare, scans their output for stray credentials, and files each report into its evidence record on a schedule.

If that is the integration you came for, there is no code to write: install it with npx @devguardch/cli, then follow the setup guide or consult the CLI reference.

Integrated Documentation

The application includes built-in help that you can access anytime from the help icon in the top-right corner. Instead of maintaining a separate user manual, all guidance is delivered directly inside the interface, so the information you see is always up to date and relevant to what you're working on.

This contextual help explains features, offers short tips, and provides extra guidance where needed. The same guidance is published here as the guides, and alongside them this site maintains two stand-alone references: the API reference and the CLI reference.