Xerox Status API

Health and status monitoring

OpenAPI Specification

xerox-status-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Xerox Public Print EULA Status API
  description: REST API for managing print jobs through the Xerox Public Print Service. Provides endpoints for job creation, status monitoring, site discovery, provider management, EULA handling, and print history management. All secure calls require xrxauth, user-email, and appid headers. If user-email is omitted the request is treated as an application request.
  version: 5.5.0
  contact:
    name: Xerox Developer Program
    url: https://www.xerox.com/en-us/about/developer-program
    email: xerox.global.developer.program@xerox.com
  termsOfService: https://www.xerox.com/en-us/about/legal
servers:
- url: https://publicprintapi.services.xerox.com/api/v1
  description: Xerox Public Print API Production Server
security:
- xrxauth: []
tags:
- name: Status
  description: Health and status monitoring
paths:
  /Status:
    get:
      operationId: getStatus
      summary: Get API Status
      description: Health check endpoint for monitoring the Xerox Public Print API status.
      tags:
      - Status
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
components:
  schemas:
    StatusResponse:
      type: object
      description: API health status
      properties:
        status:
          type: string
          description: Health status (OK, Degraded, etc.)
        timestamp:
          type: string
          format: date-time
          description: Time of status check
  securitySchemes:
    xrxauth:
      type: apiKey
      in: header
      name: xrxauth
      description: Xerox authentication credentials
    userEmail:
      type: apiKey
      in: header
      name: user-email
      description: User email address for user-context requests
    appId:
      type: apiKey
      in: header
      name: appid
      description: Application identifier
externalDocs:
  description: Xerox Public Print API Documentation
  url: https://publicprintapi.services.xerox.com/