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

# Quickstart

> Create an API key, search vulnerability intelligence, and retrieve a vulnerability by its CVE ID.

Create an API key and make your first Zero requests with `curl`.

> [!NOTE]
>
> Integrating Zero with an AI agent? Follow the [MCP quickstart](https://docs.zdlake.com/mcp/quickstart.md) to connect Codex, Claude Code, or another MCP client.

**1. Provision an API key**

Sign in with Google to the [Zero dashboard](https://zdlake.com/developers), open **Developers**, and select **Create API key**. Give the key a name that identifies its application or environment.

Copy the secret when it is shown. Zero displays it once and stores only a secure hash.

```bash theme={null}
export ZERO_API_KEY="sk_your_key"
```

Keep the key in your secret manager for deployed applications. Do not commit it to source control or include it in URLs.

**2. Search vulnerability intelligence**

Send a `POST` request to `/search`. This example searches vulnerability records for Log4j and returns at most five results.

```bash theme={null}
curl --request POST "https://api.zdlake.com/search" \
  --header "Authorization: Bearer $ZERO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "q": "log4j",
    "entity": ["vulnerability"],
    "limit": 5
  }'
```

**3. Read the result**

Search responses place matching records in `data` and paging information in `_meta`. The response below is shortened to show the fields you need for the next request.

```json theme={null}
{
  "data": [
    {
      "entity": "vulnerability",
      "entity_id": "0198b4b7-5dc1-7c82-a901-559b9c55c314",
      "id": "CVE-2021-44228",
      "title": "Apache Log4j2 remote code execution",
      "summary": "Log4j2 JNDI features can allow attacker-controlled code execution."
    }
  ],
  "_meta": {
    "total": 1,
    "next": null
  }
}
```

Use `id` when an entity has a recognized public identifier such as a CVE, CWE, or CAPEC ID. Use `entity_id` when you need a durable internal reference.

**4. Retrieve the vulnerability**

Use the public CVE ID to retrieve the normalized vulnerability. The `include` parameters add its overview and risk projections to the response.

```bash theme={null}
curl "https://api.zdlake.com/vulnerabilities/CVE-2021-44228?include=overview&include=risk" \
  --header "Authorization: Bearer $ZERO_API_KEY"
```

A detail response returns the matching record in `data`. Follow its provenance when you need to verify a normalized value against the records supplied by upstream sources.

## Continue building

> [card] [Vulnerabilities](https://docs.zdlake.com/concepts/vulnerabilities.md)
>
> Understand the vulnerability schema and its related concepts.

> [card] [Query builder](https://docs.zdlake.com/api/query-builder.md)
>
> Filter fields and compose nested AND, OR, and NOT conditions.

> [card] [Pagination](https://docs.zdlake.com/api/pagination.md)
>
> Continue a search with the cursor returned in `_meta.next`.

> [card] [Authentication](https://docs.zdlake.com/api/authentication.md)
>
> Store, send, rotate, and revoke API credentials safely.


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