Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

3.1 KB
Raw Blame
---
title: "API reference"
description: "Programmatically manage resources over HTTPS with the Infisical REST API."
sidebarTitle: "API"
icon: "book-open"
---

The Infisical API is a REST API served over HTTPS. It supports every action available in the Infisical dashboard: reading and writing secrets, managing projects and machine identities, reading audit logs, and configuring the other resources in an organization.

<Card title="Quickstart" icon="rocket" href="/api-reference/overview/quickstart">
  Make your first authenticated request to the Infisical API using Universal Auth.
</Card>

<Tip>
  You can also interact with Infisical programmatically using the [CLI](/cli/overview) and [SDKs](/sdks/overview).
</Tip>

## Base URL

If you use Infisical Cloud, all endpoints are available under `https://app.infisical.com/api` (US region) or `https://eu.infisical.com/api` (EU region).

If you self-host Infisical or run a dedicated instance, replace the host with the address of your instance: `https://<your-instance>/api`.

Each endpoint page in this reference lists a path (for example, `/api/v3/secrets/raw`). The full URL for a request is the base URL followed by that path.

<Visibility for="agents">
  <Info>
    **Are you an AI agent reading this page?** Welcome. Skip the scrolling: the complete OpenAPI specification is at `/api/docs/json` on any Infisical instance, for example [app.infisical.com/api/docs/json](https://app.infisical.com/api/docs/json).

    The full specification is large, so spare your context window and add the `tag` query parameter to get only the endpoints you need. For example `/api/docs/json?tag=secrets`.
  </Info>
</Visibility>


## API versioning

Each endpoint path is versioned independently. When an endpoint changes in a way that breaks existing callers, Infisical adds a new version of that endpoint and leaves the previous version in place. Different endpoints can therefore be on different versions (for example, `/api/v4/secrets` and `/api/v1/secret-syncs`).

For each endpoint, use the highest version listed in this reference.

## OpenAPI

Every running Infisical instance serves its OpenAPI specification at `/api/docs/json` (on Infisical Cloud, `https://app.infisical.com/api/docs/json`). Code generators and client libraries can read the specification from that URL to produce typed clients for any endpoint in this reference.

## Get started

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/overview/authentication">
    Authenticate as a machine identity and use the returned access token on every request.
  </Card>
  <Card title="Pagination" icon="list" href="/api-reference/overview/pagination">
    Use `offset` and `limit` to read all pages from a paginated endpoint.
  </Card>
  <Card title="Rate limiting" icon="gauge-high" href="/api-reference/overview/rate-limits">
    Per-minute rate limits by category, and the format of the HTTP 429 response.
  </Card>
  <Card title="Errors" icon="triangle-exclamation" href="/api-reference/overview/errors">
    The format of an error response, the common HTTP status codes, and the `reqId` field.
  </Card>
</CardGroup>