Skip to main content
GET
/
tls_certificates
List
curl --request GET \
  --url https://api.ngrok.com/tls_certificates \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "tls_certificates": [
    {
      "id": "<string>",
      "uri": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "metadata": "<string>",
      "certificate_pem": "<string>",
      "subject_common_name": "<string>",
      "subject_alternative_names": {
        "dns_names": [
          "<string>"
        ],
        "ips": [
          "<string>"
        ]
      },
      "issued_at": "<string>",
      "not_before": "<string>",
      "not_after": "<string>",
      "key_usages": [
        "<string>"
      ],
      "extended_key_usages": [
        "<string>"
      ],
      "private_key_type": "<string>",
      "issuer_common_name": "<string>",
      "serial_number": "<string>",
      "subject_organization": "<string>",
      "subject_organizational_unit": "<string>",
      "subject_locality": "<string>",
      "subject_province": "<string>",
      "subject_country": "<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 TLS certificates on this account

tls_certificates
object[]

the list of all TLS certificates on this account

uri
string

URI of the TLS certificates list API resource

next_page_uri
string

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