Clerk

Clerk Domains API

Domains represent each instance's URLs and DNS setup.

GitHub OpenAPI

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /domains List my instance's primary and satellite domains · List All Instance Domains #
Ask an LLM
“Which domains is my Clerk instance currently running on, including satellites?”
“Can I see the primary domain alongside every satellite domain for this instance?”
Tell an agent
List the primary and satellite domains configured on my instance.
Show me the frontend and accounts URLs for each domain on this instance.
POST /domains Add a satellite domain to an instance · Add a Domain #
Ask an LLM
“How do I add a satellite domain to a multi-domain instance?”
“Can a new instance domain include a port like localhost:3000 in development?”
Tell an agent
Add {name} as a satellite domain on my instance.
Add satellite domain {name} served through proxy {proxy_url}.
DELETE /domains/{domain_id} Delete a satellite domain from the instance · Delete a Satellite Domain #
Ask an LLM
“How do I remove a satellite domain I no longer use from my instance?”
“Is it possible to delete the instance's primary domain?”
Tell an agent destructive · confirm first
Delete satellite domain {domain_id} from my instance.
Remove the satellite instance domain {domain_id}.
PATCH /domains/{domain_id} Update an instance domain or its proxy URL · Update a Domain #
Ask an LLM
“How do I set a proxy URL on my production instance's domain?”
“Can I rename a primary or satellite domain on my instance after it's created?”
Tell an agent
Set the proxy URL of instance domain {domain_id} to {proxy_url}.
Rename instance domain {domain_id} to {name}.
POST /v1/organizations/{organization_id}/domains Add a domain to an organization · Create Organization Domain #
Ask an LLM
“How do I add a company email domain to an organization as the signed-in user?”
“What do I need to register a new domain on my organization?”
Tell an agent
Add domain {name} to organization {organization_id}.
Register {name} as an organization domain for {organization_id}.
GET /v1/organizations/{organization_id}/domains List an organization's domains · Get All Organization Domains #
Ask an LLM
“Which email domains are attached to this organization?”
“Can I filter an organization's domains to only verified ones or by enrollment mode?”
Tell an agent
List the domains of organization {organization_id}.
Show only verified domains for organization {organization_id}.
GET /v1/organizations/{organization_id}/domains/{domain_id} Get one organization domain's details · Get Organization Domain #
Ask an LLM
“What are the verification and enrollment details of one organization domain?”
“Can I look up a single domain on my organization by its ID?”
Tell an agent
Get domain {domain_id} of organization {organization_id}.
Show the verification status of organization domain {domain_id} in {organization_id}.
DELETE /v1/organizations/{organization_id}/domains/{domain_id} Remove a domain from an organization · Delete Organization Domain #
Ask an LLM
“How do I remove an email domain from my organization?”
“Who is allowed to delete a domain from an organization?”
Tell an agent destructive · confirm first
Remove domain {domain_id} from organization {organization_id}.
Delete organization domain {domain_id} under {organization_id}.
POST /v1/organizations/{organization_id}/domains/{domain_id}/update_enrollment_mode Change an organization domain's enrollment mode · Update Organization Enrollment Mode #
Ask an LLM
“How do I make users with a matching email domain get automatic invitations to the organization?”
“Can I switch a domain from automatic invitation to automatic suggestion and drop pending ones?”
Tell an agent
Set enrollment mode of domain {domain_id} in organization {organization_id} to {enrollment_mode}.
Switch domain {domain_id} of {organization_id} to automatic_suggestion enrollment.
POST /v1/organizations/{organization_id}/domains/{domain_id}/prepare_affiliation_verification Start affiliation verification for an org domain · Prepare Organization Domain Affiliation Verification #
Ask an LLM
“How do I prove I own an email address at my organization's domain?”
“What starts the affiliation email check for an organization domain?”
Tell an agent
Send an affiliation verification to {affiliation_email_address} for domain {domain_id} of {organization_id}.
Prepare affiliation verification for organization domain {domain_id} in {organization_id} using {affiliation_email_address}.
POST /v1/organizations/{organization_id}/domains/{domain_id}/attempt_affiliation_verification Verify an org domain with an affiliation code · Attempt Organization Domain Affiliation Verification #
Ask an LLM
“I received an affiliation code by email, how do I use it to verify my organization domain?”
“What happens when I submit the affiliation verification code for an organization domain?”
Tell an agent
Verify organization domain {domain_id} in {organization_id} with code {code}.
Submit affiliation code {code} for domain {domain_id} of organization {organization_id}.
PATCH /platform/applications/{applicationID}/domain Change an application's production domain · Update Application Domain #
Ask an LLM
“How do I change the production domain of one of my Clerk applications?”
“Can I set a proxy path when I move an application to a new production domain?”
Tell an agent
Change the production domain of application {applicationID} to {name}.
Move application {applicationID} to production domain {name} behind proxy path {proxy_path}.
GET /platform/applications/{applicationID}/domains List an application's production domains · List Application Domains #
Ask an LLM
“Which domains are on this application's production instance?”
“Can I see every provider domain attached to one application?”
Tell an agent
List production domains for application {applicationID}.
Show all domains on the production instance of {applicationID}.
POST /platform/applications/{applicationID}/domains Add a provider domain to an application · Create Application Domain #
Ask an LLM
“How do I add another provider domain to an application's production instance?”
“Can an extra production domain for an application use a proxy path?”
Tell an agent
Add provider domain {name} to application {applicationID}.
Create domain {name} on the production instance of {applicationID} with proxy path {proxy_path}.
GET /platform/applications/{applicationID}/domains/{domainIDOrName} Get one domain of an application · Get Application Domain #
Ask an LLM
“Can I look up an application domain by its name instead of its ID?”
“What configuration does a specific domain of my application have?”
Tell an agent
Get domain {domainIDOrName} of application {applicationID}.
Show details for application {applicationID}'s domain {domainIDOrName}.
DELETE /platform/applications/{applicationID}/domains/{domainIDOrName} Delete a provider domain from an application · Delete Application Domain #
Ask an LLM
“How do I remove a provider domain from an application's production instance?”
“Can the primary domain of an application be deleted?”
Tell an agent destructive · confirm first
Delete provider domain {domainIDOrName} from application {applicationID}.
Remove {domainIDOrName} from the production domains of {applicationID}.
GET /platform/applications/{applicationID}/domains/{domainIDOrName}/status Check an application domain's status · Get Application Domain Status #
Ask an LLM
“Is my application's domain fully set up yet?”
“What is the current DNS and SSL status of an application domain?”
Tell an agent
Check the status of domain {domainIDOrName} for application {applicationID}.
Tell me whether {domainIDOrName} on application {applicationID} is ready.
POST /platform/applications/{applicationID}/domains/{domainIDOrName}/dns_check Run a fresh DNS check on an application domain · Trigger DNS Check #
Ask an LLM
“How do I force a new DNS check after updating my domain's records?”
“Why would triggering a DNS check return a 409 conflict?”
Tell an agent
Trigger a DNS check for domain {domainIDOrName} of application {applicationID}.
Re-run DNS verification on {domainIDOrName} for {applicationID} now.
GET /platform/domains List domains across my workspace's applications · List Domains #
Ask an LLM
“Which production domains exist across all applications in my workspace?”
“Can I include development instance domains when listing my workspace's domains?”
Tell an agent
List every production domain in my workspace, newest first.
Find workspace domains matching {name}, including development ones.
GET /platform/domains/{domainIDOrName} Get a workspace domain by ID or name · Get Domain #
Ask an LLM
“Can I look up a domain in my workspace without knowing which application owns it?”
“What does the workspace-level record for a single domain contain?”
Tell an agent
Get workspace domain {domainIDOrName}.
Look up {domainIDOrName} across my workspace's domains.

Documentation

📖
Documentation
https://clerk.com/docs/reference/backend-api
📖
APIReference
https://clerk.com/docs/reference/backend-api
📖
GettingStarted
https://clerk.com/docs/quickstarts/overview
📖
Authentication
https://clerk.com/docs/backend-requests/making/jwt-templates
📖
Documentation
https://clerk.com/docs
📖
Documentation
https://clerk.com/docs/webhooks/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clerk-com/refs/heads/main/openapi/clerk-com-domains-api-openapi.yml

Other Resources

🔗
SpectralRuleset
https://raw.githubusercontent.com/api-evangelist/clerk-com/refs/heads/main/rules/clerk-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clerk-com-domains-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clerk-com-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Clerk Com Domains API
  termsOfService: https://clerk.com/terms
  x-logo:
    url: https://clerk.com/_next/image?url=%2Fimages%2Fclerk-logo.svg&w=96&q=75
    altText: Clerk docs
    href: https://clerk.com/docs
  version: '1.0'
  description: 'Operations tagged Domains across 3 of this provider''s published API definitions: clerk-backend-api-openapi.yml, clerk-frontend-api-openapi.yml, clerk-platform-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.clerk.com/v1
- url: https://{domain}.clerk.accounts.dev
  variables:
    domain:
      default: example-destined-camel-13
      description: Your Development Instance Frontend API Domain.
tags:


# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clerk-com/refs/heads/main/openapi/clerk-com-domains-api-openapi.yml