The redirect.pizza API can be used to manage your redirects, email forwards, list your domains and view your team's quota.
Authentication
When logged into your account, navigate to the 'API' tab. Here you can create an API token. You may create multiple API tokens under a single team. You can use this API token as the Bearer token in the JSON RESTful API:
curl --header "Authorization: Bearer rpa_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
https://redirect.pizza/api/v1/redirects
Scopes
You may limit API tokens to specific scopes. The following scopes are supported:
- redirects:read
- redirects:write
- email-forwards:read
- email-forwards:write
- domains:manage
- analytics:read
- team:read
Tag access
You may limit API tokens to have access to specific tags only, or disallow access to specific tags. This allows you to create API tokens that may only access a subset of redirects.
Endpoints
Redirects
GET /api/v1/redirects: List all redirects.
GET /api/v1/redirects/$REDIRECTID$: Show a specific redirect by it's ID. You can fetch the ID from the list call or from the control panel.
POST /api/v1/redirects: Add a new redirect
PUT /api/v1/redirects: Update an existing redirect
DELETE /api/v1/redirects/$REDIRECTID$: Delete a redirect
Email forwards
GET /api/v1/email-forwards: List all email forwards.
GET /api/v1/email-forwards/$EMAILFORWARDID$: Show a specific email forward by it's ID. You can fetch the ID from the list call or from the control panel.
POST /api/v1/email-forwards: Add a new email forward
PUT /api/v1/email-forwards: Update an existing email forward
DELETE /api/v1/email-forwards/$EMAILFORWARDID$: Delete a email forward
Domains / Hostnames
GET /api/v1/domains: List all domains.
GET /api/v1/domains/$DOMAINID$: Show a specific domain by it's ID. You can fetch the ID from the list call or from the control panel.
POST /api/v1/domains/$DOMAINID$/check-dns: Force-check the DNS.
Team
GET /api/v1/team: View team quota details