Apache Tomcat SSL API

SSL/TLS certificate and cipher management

OpenAPI Specification

tomcat-ssl-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Apache Tomcat Manager Applications SSL API
  description: The Apache Tomcat Manager application provides an HTTP text interface for deploying, managing, and monitoring Java web applications. Includes application lifecycle management (deploy, start, stop, reload, undeploy), session management, server status, diagnostics (thread dumps, VM info, memory leak detection), SSL/TLS management, JMX proxy access, and configuration persistence.
  version: '10.1'
  contact:
    name: Apache Tomcat Users Mailing List
    url: https://tomcat.apache.org/lists.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/manager
  description: Local Tomcat instance (default)
security:
- basicAuth: []
tags:
- name: SSL
  description: SSL/TLS certificate and cipher management
paths:
  /text/sslConnectorCiphers:
    get:
      operationId: getSslCiphers
      summary: Get SSL Connector Ciphers
      description: Returns the SSL/TLS ciphers currently in use for each SSL connector.
      tags:
      - SSL
      responses:
        '200':
          description: SSL cipher information
          content:
            text/plain:
              schema:
                type: string
  /text/sslConnectorCerts:
    get:
      operationId: getSslCertificates
      summary: Get SSL Connector Certificates
      description: Returns certificate chain information for each SSL connector.
      tags:
      - SSL
      responses:
        '200':
          description: SSL certificate chain information
          content:
            text/plain:
              schema:
                type: string
  /text/sslConnectorTrustedCerts:
    get:
      operationId: getSslTrustedCertificates
      summary: Get SSL Trusted Certificates
      description: Returns trusted certificate information for each SSL connector.
      tags:
      - SSL
      responses:
        '200':
          description: Trusted certificate information
          content:
            text/plain:
              schema:
                type: string
  /text/sslReload:
    get:
      operationId: reloadSslConfiguration
      summary: Reload SSL Configuration
      description: Reloads SSL/TLS certificate and key files without re-parsing server.xml. Optionally targets a specific TLS virtual host.
      tags:
      - SSL
      parameters:
      - name: tlsHostName
        in: query
        schema:
          type: string
        description: Specific TLS virtual host name to reload
      responses:
        '200':
          description: SSL reload result
          content:
            text/plain:
              schema:
                type: string
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic authentication. User must have appropriate role in tomcat-users.xml: manager-script for text interface, manager-jmx for JMX proxy.'