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

# API reference

> Reference documentation for the Periscope APIs.

Periscope provides two APIs:

## Deployment webhook API

The deployment webhook is a REST endpoint for ingesting deployment events from your CI/CD pipeline. It is the only write API that Periscope exposes to customers.

* **Base URL:** `https://app.periscope.sh/api/webhooks/deployments`
* **Authentication:** Bearer token (API key from Settings > Deployments)
* **Format:** JSON

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    How to authenticate with the deployment API using API keys.
  </Card>

  <Card title="Ingest deployment" icon="upload" href="/api-reference/ingest-deployment">
    Send a deployment event to Periscope.
  </Card>

  <Card title="Payload schema" icon="brackets-curly" href="/api-reference/payload-schema">
    Full field-by-field reference for the deployment payload.
  </Card>
</CardGroup>

## MCP server

The MCP server provides read-only access to all Periscope metrics through the Model Context Protocol. It is designed for use with AI coding assistants rather than direct API calls.

* **URL:** `https://app.periscope.sh/mcp`
* **Authentication:** OAuth 2.0 via WorkOS
* **Protocol:** MCP over HTTP

See the [MCP integration guide](/integrations/mcp) for setup instructions and the full list of 18 available tools.