API Documentation

Use the SaaS Custom Domains API to programmatically access upstreams, custom domains, and other resources to seamlessly integrate custom domains into your product.

Quickstart

Getting started

To get started, create a new API token in your API settings, then read about how to make requests for the resources you need to access using our HTTP APIs.

Get your API key

Guides

Authentication

Learn how to authenticate your API requests.

Pagination

Understand how to work with paginated responses.

Handling Forwarded Requests

Read about how to handle forwarded requests from custom domains.

Custom Domain Types

Understand the different types of custom domains and how to use them.

Webhooks

Learn how to use webhooks to receive notifications about events in the API.

Rate Limits

Learn about the rate limits that apply to the API and how to handle them.

Errors

Read about the different types of errors returned by the API.

Upstreams

Learn about the upstream model and how to create, retrieve, update, delete, and list upstreams.

Custom domains

Learn about the custom domain model and how to create, retrieve, update, delete, and list custom domains.

Accounts

Learn about the account model and how to access accounts programmatically..