Skip to main content
PATCH
/
certificate_authorities
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/certificate_authorities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "id": "<string>",
  "description": "<string>",
  "metadata": "<string>"
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "ca_pem": "<string>",
  "subject_common_name": "<string>",
  "not_before": "<string>",
  "not_after": "<string>",
  "key_usages": [
    "<string>"
  ],
  "extended_key_usages": [
    "<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

Path Parameters

​
id
string
required

Body

application/json
​
id
string

n/a

​
description
string

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

​
metadata
string

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

Response

200 - application/json

Update attributes of a Certificate Authority by ID

​
id
string

unique identifier for this Certificate Authority

​
uri
string

URI of the Certificate Authority API resource

​
created_at
string

timestamp when the Certificate Authority was created, RFC 3339 format

​
description
string

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

​
metadata
string

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

​
ca_pem
string

raw PEM of the Certificate Authority

​
subject_common_name
string

subject common name of the Certificate Authority

​
not_before
string

timestamp when this Certificate Authority becomes valid, RFC 3339 format

​
not_after
string

timestamp when this Certificate Authority becomes invalid, RFC 3339 format

​
key_usages
string[]

set of actions the private key of this Certificate Authority can be used for

​
extended_key_usages
string[]

extended set of actions the private key of this Certificate Authority can be used for