Skip to main content
PATCH
/
tls_certificates
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/tls_certificates/{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>",
  "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>"
}

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 TLS certificate. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.

Response

200 - application/json

Update attributes of a TLS Certificate by ID

​
id
string

unique identifier for this TLS certificate

​
uri
string

URI of the TLS certificate API resource

​
created_at
string

timestamp when the TLS certificate was created, RFC 3339 format

​
description
string

human-readable description of this TLS certificate. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.

​
certificate_pem
string

chain of PEM-encoded certificates, leaf first. See Certificate Bundles.

​
subject_common_name
string

subject common name from the leaf of this TLS certificate

​
subject_alternative_names
object

subject alternative names (SANs) from the leaf of this TLS certificate

​
issued_at
string

timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded

​
not_before
string

timestamp when this TLS certificate becomes valid, RFC 3339 format

​
not_after
string

timestamp when this TLS certificate becomes invalid, RFC 3339 format

​
key_usages
string[]

set of actions the private key of this TLS certificate can be used for

​
extended_key_usages
string[]

extended set of actions the private key of this TLS certificate can be used for

​
private_key_type
string

type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.

​
issuer_common_name
string

issuer common name from the leaf of this TLS certificate

​
serial_number
string

serial number of the leaf of this TLS certificate

​
subject_organization
string

subject organization from the leaf of this TLS certificate

​
subject_organizational_unit
string

subject organizational unit from the leaf of this TLS certificate

​
subject_locality
string

subject locality from the leaf of this TLS certificate

​
subject_province
string

subject province from the leaf of this TLS certificate

​
subject_country
string

subject country from the leaf of this TLS certificate