SSL/TLS

opencollection: 1.0.0
info:
  name: SSL/TLS Certificate Management API
  version: '1.0'
request:
  auth:
    type: apikey
    key: X-API-Key
    value: '{{X-API-Key}}'
    placement: header
items:
- info:
    name: Certificates
    type: folder
  items:
  - info:
      name: List Certificates
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/certificates
      params:
      - name: status
        value: ''
        type: query
        description: Filter by certificate status
      - name: domain
        value: ''
        type: query
        description: Filter by domain name
      - name: expiringBefore
        value: ''
        type: query
        description: Filter certificates expiring before this date (ISO 8601)
      - name: page
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: Returns a paginated list of SSL/TLS certificates in the account, including their status, expiry dates, and associated
      domains.
  - info:
      name: Request Certificate
      type: http
    http:
      method: POST
      url: https://api.certmanager.example.com/v1/certificates
      body:
        type: json
        data: '{}'
    docs: Initiates a certificate issuance request for one or more domain names. Returns an order object with challenge details
      for domain validation.
  - info:
      name: Get Certificate
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/certificates/:certificateId
      params:
      - name: certificateId
        value: ''
        type: path
        description: Certificate identifier
    docs: Returns full details for a specific certificate including PEM data and metadata.
  - info:
      name: Download Certificate
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/certificates/:certificateId/download
      params:
      - name: certificateId
        value: ''
        type: path
        description: Certificate identifier
      - name: format
        value: ''
        type: query
    docs: Downloads the certificate and certificate chain in PEM format. Returns the end-entity certificate and full chain
      for installation.
  - info:
      name: Renew Certificate
      type: http
    http:
      method: POST
      url: https://api.certmanager.example.com/v1/certificates/:certificateId/renew
      params:
      - name: certificateId
        value: ''
        type: path
        description: Certificate identifier
      body:
        type: json
        data: '{}'
    docs: Initiates certificate renewal for an existing certificate. Uses the same domain list and key unless overridden.
      Returns a new order object.
- info:
    name: Revocation
    type: folder
  items:
  - info:
      name: Revoke Certificate
      type: http
    http:
      method: POST
      url: https://api.certmanager.example.com/v1/certificates/:certificateId/revoke
      params:
      - name: certificateId
        value: ''
        type: path
        description: Certificate identifier
      body:
        type: json
        data: '{}'
    docs: Revokes a certificate, making it immediately invalid. Revoked certificates appear in the CA's CRL and OCSP responses.
      Provide a reason code.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List Orders
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/orders
      params:
      - name: status
        value: ''
        type: query
      - name: page
        value: ''
        type: query
    docs: Returns a list of certificate orders with their current status and validation state.
  - info:
      name: Get Order
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/orders/:orderId
      params:
      - name: orderId
        value: ''
        type: path
    docs: Returns the current status of a certificate order including challenge status.
- info:
    name: Domains
    type: folder
  items:
  - info:
      name: Verify Domain Challenge
      type: http
    http:
      method: POST
      url: https://api.certmanager.example.com/v1/orders/:orderId/challenges/:challengeId/verify
      params:
      - name: orderId
        value: ''
        type: path
      - name: challengeId
        value: ''
        type: path
    docs: Notifies the CA to verify a completed domain ownership challenge. The CA will check for the expected token at the
      challenge URL or DNS record. Once verified, the order can proceed to certificate issuance.
  - info:
      name: List Domains
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/domains
    docs: Returns all domains registered in the account with their validation status.
- info:
    name: Monitoring
    type: folder
  items:
  - info:
      name: Get Expiring Certificates
      type: http
    http:
      method: GET
      url: https://api.certmanager.example.com/v1/monitoring/expiring
      params:
      - name: days
        value: ''
        type: query
        description: Number of days to look ahead for expiring certificates
    docs: Returns certificates expiring within the specified number of days. Use this for automated renewal workflows and
      alerting.
bundled: true