Optimizely Sites API

openapi: 3.2.0
info:
  title: Optimizely Content Delivery Sites API
  description: The Optimizely Content Delivery API is a flexible REST API for building headless CMS solutions with Optimizely CMS. It provides a pluggable and configurable web API for querying content, enabling developers to deliver content to any frontend framework or channel. The API supports content retrieval, filtering, expansion of content references, and querying of sites and content types for building decoupled architectures using frameworks like React, Vue, or Angular.
  version: '3.0'
  contact:
    name: Optimizely Support
    url: https://support.optimizely.com
  termsOfService: https://www.optimizely.com/legal/terms/
servers:
- url: '{siteUrl}/api/episerver/v3.0'
  description: Optimizely CMS Content Delivery API endpoint
  variables:
    siteUrl:
      default: https://www.example.com
      description: The base URL of the Optimizely CMS site
security:
- bearerAuth: []
- anonymous: []
tags:
- name: Sites
  description: Retrieve site definitions including language settings and configuration.
paths:
  /site:
    get:
      operationId: listSites
      summary: List sites
      description: Returns a list of site definitions configured in the Optimizely CMS instance, including language settings and site URLs.
      tags:
      - Sites
      parameters:
      - $ref: '#/components/parameters/language'
      responses:
        '200':
          description: Successfully retrieved site definitions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Site'
        '401':
          description: Authentication credentials are missing or invalid
components:
  schemas:
    Site:
      type: object
      description: A site definition in the Optimizely CMS instance
      properties:
        name:
          type: string
          description: Name of the site
        contentRoots:
          type: object
          description: Root content references for the site
          additionalProperties:
            type: object
            properties:
              id:
                type: integer
                description: Content ID
              url:
                type: string
                format: uri
                description: URL to the content
        languages:
          type: array
          description: Languages configured for the site
          items:
            type: object
            properties:
              displayName:
                type: string
                description: Display name of the language
              name:
                type: string
                description: Language code
              isMasterLanguage:
                type: boolean
                description: Whether this is the master language
              urlSegment:
                type: string
                description: URL segment for the language
              url:
                type: string
                format: uri
                description: Language-specific site URL
        hosts:
          type: array
          description: Host names configured for the site
          items:
            type: object
            properties:
              name:
                type: string
                description: Host name
              type:
                type: string
                description: Host type
  parameters:
    language:
      name: language
      in: query
      required: false
      description: The language code for content retrieval
      schema:
        type: string
        example: en
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 or OpenID Connect Bearer token for authenticated access.
    anonymous:
      type: http
      scheme: bearer
      description: Anonymous access for publicly available content.
externalDocs:
  description: Optimizely Content Delivery API Documentation
  url: https://docs.developers.optimizely.com/content-management-system/v1.5.0-content-delivery-api/docs/content-delivery-api