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 SSH Certificate Authorities API

SSH Certificate Authorities manage keys for signing SSH certificates.

ngrok SSH 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 SSH 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 SSH 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.

SSH Certificate Authorities 5

SSH Certificate Authorities manage keys for signing SSH certificates.

POST
/ssh_certificate_authorities
Ngrok Create SSH Certificate Authority
createSshCertificateAuthority body → 201
GET
/ssh_certificate_authorities
Ngrok List SSH Certificate Authorities
listSshCertificateAuthorities 2 params → 200
GET
/ssh_certificate_authorities/{id}
Ngrok Get SSH Certificate Authority
getSshCertificateAuthority 1 param → 200
PATCH
/ssh_certificate_authorities/{id}
Ngrok Update SSH Certificate Authority
updateSshCertificateAuthority 1 param body → 200
DELETE
/ssh_certificate_authorities/{id}
Ngrok Delete SSH Certificate Authority
deleteSshCertificateAuthority 1 param → 204

Schemas 2

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

SshCertificateAuthority
object
7 properties
SshCertificateAuthorityList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ngrok-ssh-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 Certificate Authorities 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