openapi: 3.1.0
info:
  title: ACME (RFC 8555) Protocol Account Order API
  description: The Automatic Certificate Management Environment (ACME) protocol, defined in IETF RFC 8555, automates the interactions between Certificate Authorities and clients for issuing, renewing, and revoking X.509 certificates. ACME requests are JSON Web Signature (JWS) payloads carried over HTTPS. Server URLs are advertised by each ACME directory; this spec uses generic /acme/* paths.
  version: 1.0.0
  contact:
    name: IETF Datatracker
    url: https://datatracker.ietf.org/doc/html/rfc8555
  license:
    name: IETF Trust
    url: https://trustee.ietf.org/license-info
servers:
- url: https://acme-v02.api.letsencrypt.org
  description: Let's Encrypt production ACME directory (reference implementation)
- url: https://acme-staging-v02.api.letsencrypt.org
  description: Let's Encrypt staging ACME directory
tags:
- name: Order
  description: Certificate order workflow.
paths:
  /acme/new-order:
    post:
      operationId: newOrder
      summary: Submit a certificate order
      description: Submit a certificate issuance order with identifiers (e.g. DNS names).
      tags:
      - Order
      requestBody:
        required: true
        content:
          application/jose+json:
            schema:
              $ref: '#/components/schemas/JwsRequest'
      responses:
        '201':
          description: Order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
  /acme/order/{id}:
    post:
      operationId: getOrder
      summary: Retrieve an order
      description: Fetch order status and details (POST-as-GET signed request).
      tags:
      - Order
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/jose+json:
            schema:
              $ref: '#/components/schemas/JwsRequest'
      responses:
        '200':
          description: Order details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
  /acme/order/{id}/finalize:
    post:
      operationId: finalizeOrder
      summary: Finalize an order
      description: Finalize a ready order by submitting a CSR.
      tags:
      - Order
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/jose+json:
            schema:
              $ref: '#/components/schemas/JwsRequest'
      responses:
        '200':
          description: Finalized order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
components:
  schemas:
    GenericResponse:
      type: object
      additionalProperties: true
    JwsRequest:
      type: object
      description: A JSON Web Signature (JWS) flattened serialization object.
      properties:
        protected:
          type: string
          description: Base64url-encoded JWS Protected Header.
        payload:
          type: string
          description: Base64url-encoded payload.
        signature:
          type: string
          description: Base64url-encoded JWS signature.
      required:
      - protected
      - payload
      - signature
      additionalProperties: true
x-generated-from: https://datatracker.ietf.org/doc/html/rfc8555
x-generated-by: claude-crawl-2026-05-08