Skip to main content
POST
/
ssh_certificate_authorities
Create
curl --request POST \
  --url https://api.ngrok.com/ssh_certificate_authorities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "description": "<string>",
  "metadata": "<string>",
  "private_key_type": "<string>",
  "elliptic_curve": "<string>",
  "key_size": 123
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "public_key": "<string>",
  "key_type": "<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

Body

application/json
​
description
string

human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

​
private_key_type
string

the type of private key to generate. one of rsa, ecdsa, ed25519

​
elliptic_curve
string

the type of elliptic curve to use when creating an ECDSA key

​
key_size
integer

the key size to use when creating an RSA key. one of 2048 or 4096

Response

201 - application/json

Create a new SSH Certificate Authority

​
id
string

unique identifier for this SSH Certificate Authority

​
uri
string

URI of the SSH Certificate Authority API resource

​
created_at
string

timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format

​
description
string

human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

​
public_key
string

raw public key for this SSH Certificate Authority

​
key_type
string

the type of private key for this SSH Certificate Authority