cURL
curl --request GET \ --url https://api.ngrok.com/reserved_domains \ --header 'Authorization: Bearer <token>' \ --header 'ngrok-version: <ngrok-version>'
{ "reserved_domains": [ { "id": "<string>", "uri": "<string>", "created_at": "<string>", "description": "<string>", "metadata": "<string>", "domain": "<string>", "region": "<string>", "cname_target": "<string>", "certificate": { "id": "<string>", "uri": "<string>" }, "certificate_management_policy": { "authority": "<string>", "private_key_type": "<string>" }, "certificate_management_status": { "renews_at": "<string>", "provisioning_job": { "error_code": "<string>", "msg": "<string>", "started_at": "<string>", "retries_at": "<string>" } }, "acme_challenge_cname_target": "<string>" } ], "uri": "<string>", "next_page_uri": "<string>" }
List all reserved custom domains in your ngrok account with optional filtering and pagination.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
List all reserved domains on this account.
the list of all reserved domains on this account
Show child attributes
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
Was this page helpful?