> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snapsec.co/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Comprehensive guide to the Snapsec REST API for programmatically managing assets, scans, findings, and workflows.

The Snapsec REST API provides programmatic access to all platform capabilities.

***

## API Architecture

* **Base URL (Cloud)**: `https://api.suite.snapsec.co/v2`
* **Base URL (On-Prem / Air-Gapped)**: `https://<your-domain>/api/v2`
* **Data Format**: Standard JSON request and response payloads.
* **Protocol**: HTTPS (TLS 1.3 enforced).
* **Versioning**: URI path versioning (`/v2/`).

***

## Interactive API Explorer

You can test API endpoints using standard tools like `curl`, Postman, or our official Python and Go SDKs.

```bash theme={null}
curl -X GET "https://api.suite.snapsec.co/v2/findings" \
  -H "Authorization: Bearer sec_live_9f83a0bc1..." \
  -H "Accept: application/json"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.