Skip to navigation

Passport API Reference Overview

The Passport API lets you manage your Passport setup programmatically, instead of through the Passport app. Use it to provision namespaces, register endpoints, and control who can access them.

Namespaces group your team’s APIs, and each one holds resource groups, secret references, and endpoints. A secret reference points to a credential in your secret store without exposing it, and a secret binding maps that reference to a specific endpoint so the Passport Proxy can resolve it at request time. Endpoints are the individual APIs your team calls through the proxy. You can also use the API to submit and manage requests for access to a resource group or endpoint.

For example, you might create a namespace for your payments service, add a stripe-secret-key secret reference, register the POST /v1/charges endpoint, and bind that reference to its Authorization header.

Every request must include an API key as a bearer token in the Authorization header.

Rate limits apply to every request.