Skip to main content
The Yertle API uses Personal Access Tokens (PATs) as the primary authentication method for API consumers — the same pattern used by GitHub, Linear, Stripe, and others. Every request to a protected endpoint must include an Authorization header.

​
Header format

The <token> is your PAT (a string that begins with yrt_).

​
Getting a token

  1. Sign in at yertle.com and open your settings page.
  2. Under Personal Access Tokens, click Create token, give it a descriptive name (e.g. “my laptop”, “CI runner”), and optionally set an expiry.
  3. Copy the token that begins with yrt_.... You’ll only see it once.
Use it directly:
Or with the Yertle Python SDK:

​
Option 2: Yertle CLI

The Yertle CLI wraps PAT creation and storage — useful if you’d rather not manage the token yourself:
The CLI prompts you to generate a PAT in the web UI, pastes it back, and stores it at ~/.yertle/config.json. Subsequent yertle commands read from that file automatically.

​
Token lifetime

Personal Access Tokens don’t expire unless you set an expiration when creating them. Rotate by creating a new token, updating your scripts/CI, then revoking the old one from the settings page — other tokens are unaffected.

​
Errors

When you receive a 401, verify the token hasn’t been revoked in the settings page. Generate a new PAT if needed.

​
Permissions and roles

Authentication identifies who you are. Authorization is enforced per organization based on your role: See Concepts for more on roles and the organization model.