Skip to main content
GET
/
ssh_user_certificates
List
curl --request GET \
  --url https://api.ngrok.com/ssh_user_certificates \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "ssh_user_certificates": [
    {
      "id": "<string>",
      "uri": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "metadata": "<string>",
      "public_key": "<string>",
      "key_type": "<string>",
      "ssh_certificate_authority_id": "<string>",
      "principals": [
        "<string>"
      ],
      "critical_options": {},
      "extensions": {},
      "valid_after": "<string>",
      "valid_until": "<string>",
      "certificate": "<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 SSH User Certificates issued on this account

​
ssh_user_certificates
object[]

the list of all ssh user certificates on this account

​
uri
string

URI of the ssh user certificates list API resource

​
next_page_uri
string

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