Skip to main content
GET
/
reserved_domains
List
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>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Query Parameters

before_id
string
limit
string

Response

200 - application/json

List all reserved domains on this account.

reserved_domains
object[]

the list of all reserved domains on this account

uri
string

URI of the reserved domain list API resource

next_page_uri
string

URI of the next page, or null if there is no next page