Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ngrok Certificate Authorities API

Certificate Authorities are x509 certificates used for mutual TLS authentication.

ngrok Certificate Authorities API is one of 24 APIs that ngrok publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Certificate Authorities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, a GitHub repository, and 12 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.ngrok.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.ngrok.com
Authentication
HTTP Bearer, API Key
Contact
Resource Areas
1

Authentication & Security 2

ngrok Certificate Authorities API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Use an ngrok API key as a Bearer token. Create API keys from the ngrok dashboard or via the API Keys endpoints.
  • apiKeyAuth — Pass the API key in the Authorization header prefixed with 'Bearer '.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Certificate Authorities 5

Certificate Authorities are x509 certificates used for mutual TLS authentication.

POST
/certificate_authorities
Ngrok Create Certificate Authority
createCertificateAuthority body → 201
GET
/certificate_authorities
Ngrok List Certificate Authorities
listCertificateAuthorities 2 params → 200
GET
/certificate_authorities/{id}
Ngrok Get Certificate Authority
getCertificateAuthority 1 param → 200
PATCH
/certificate_authorities/{id}
Ngrok Update Certificate Authority
updateCertificateAuthority 1 param body → 200
DELETE
/certificate_authorities/{id}
Ngrok Delete Certificate Authority
deleteCertificateAuthority 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CertificateAuthority (11 properties), CertificateAuthorityList (3 properties). Each schema is shown below with its type and property counts.

CertificateAuthority
object
11 properties
CertificateAuthorityList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ngrok-certificate-authorities-api-openapi.yml Raw ↑

Other APIs ngrok publishes across the network.

ngrok Abuse Reports API
ngrok Agent Ingresses API
ngrok API Keys API
ngrok Backends API
ngrok Credentials API
ngrok Edges HTTPS API
ngrok Edges TCP API
ngrok Edges TLS API
ngrok Endpoints API
ngrok Event Destinations API
ngrok Event Subscriptions API
ngrok IP Policies API