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

# Cloud API Reference Introduction

> Details on the ProjectDiscovery API

## Overview

The ProjectDiscovery API v1 is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has resource-oriented URLs, accepts and returns JSON in most cases, and the API uses standard HTTP response codes, authentication, and verbs. Our API also conforms to the [OpenAPI Specification](https://www.openapis.org/).

This API documentation will walk you through each of the available resources, and provides code examples for `cURL`, `Python`, `JavaScript`, `PHP`, `Go` and `Java`. Each endpoint includes the required authorization information and parameters, and provides examples of the response you should expect.

## Authentication

The ProjectDiscovery API uses API keys to authenticate requests. You can view and manage your API key on ProjectDiscovery [Dashboard](https://cloud.projectdiscovery.io/) or in left navbar Settings > [API Key](https://cloud.projectdiscovery.io/settings/api-key).

Authentication with the API is performed using a custom request header - `X-Api-Key` - which should simply be the value of your API key found with your ProjectDiscovery account.

You must make all API calls over `HTTPS`. Calls made over plain HTTP will fail, as will requests without authentication or without all required parameters.

## Resources

Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery API.

<CardGroup cols={3}>
  <Card title="Templates" icon="puzzle" iconType="duotone" href="/api-reference/templates">
    Access public and private templates, AI template generation, and template sharing.
  </Card>

  <Card title="Scans" icon="radar" iconType="duotone" href="/api-reference/scans">
    Manage scans, scan schedules, import/export, and scan configurations.
  </Card>

  <Card title="Vulnerabilities" icon="shield-exclamation" iconType="duotone" href="/api-reference/results">
    View and manage vulnerabilities, changelogs, and retest results.
  </Card>

  <Card title="Leaks" icon="eye-slash" iconType="duotone" href="/api-reference/leaks">
    Monitor domain leaks, email leaks, and customer leak data.
  </Card>

  <Card title="Users & Authentication" icon="users" iconType="duotone" href="/api-reference/users">
    Manage API keys, user tunnels, team members, and workspace settings.
  </Card>

  <Card title="Asset Discovery" icon="radar" iconType="duotone" href="/api-reference/enumerations">
    Perform asset enumeration, discover associated domains, manage asset groups, and track discovery history.
  </Card>

  <Card title="Configurations" icon="gear" iconType="duotone" href="/api-reference/configurations">
    Configure scan settings, severity mappings, and template exclusions.
  </Card>

  <Card title="Export & Logs" icon="download" iconType="duotone" href="/api-reference/export">
    Export scan results, download logs, and access audit information.
  </Card>

  <Card title="Utilities" icon="wrench" iconType="duotone" href="/api-reference/full-text-search">
    Full-text search, filters, and additional utility functions.
  </Card>
</CardGroup>