sitecore

opencollection: 1.0.0
info:
  name: Sitecore XM Cloud REST API
  version: v1
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Collections
    type: folder
  items:
  - info:
      name: List site collections
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves a list of all site collections within the authenticated XM Cloud tenant. Returns collection metadata including
      names, identifiers, and associated site counts.
  - info:
      name: Create a site collection
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Creates a new site collection within the XM Cloud tenant. Site collections group related sites together and allow
      shared resource management. The collection name must be unique within the tenant.
  - info:
      name: Get a site collection
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections/:collectionId
      params:
      - name: collectionId
        value: ''
        type: path
        description: The unique identifier of the site collection
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves a specific site collection by its unique identifier. Returns full collection metadata including associated
      sites and configuration.
  - info:
      name: Update a site collection
      type: http
    http:
      method: PUT
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections/:collectionId
      params:
      - name: collectionId
        value: ''
        type: path
        description: The unique identifier of the site collection
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Updates the properties of an existing site collection, such as its name or description. All updateable fields must
      be provided in the request body.
  - info:
      name: Delete a site collection
      type: http
    http:
      method: DELETE
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections/:collectionId
      params:
      - name: collectionId
        value: ''
        type: path
        description: The unique identifier of the site collection
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Permanently deletes a site collection and all of its associated sites. This operation is irreversible. All sites
      within the collection must be removed or the operation will return an error.
  - info:
      name: Validate a site collection name
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections/name/validate
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Validates whether a proposed site collection name is available and meets naming requirements before creating a collection.
      Returns validation status and any error messages.
  - info:
      name: Sort site collections
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/collections/sort
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Updates the sort order of site collections as they appear in the Content Editor, Pages, and API responses. Accepts
      an ordered list of collection identifiers.
- info:
    name: Sites
    type: folder
  items:
  - info:
      name: List sites
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      - name: collectionId
        value: ''
        type: query
        description: Filter sites by parent collection identifier
    docs: Retrieves a list of all sites within the authenticated XM Cloud tenant, optionally filtered by collection. Returns
      site metadata including names, identifiers, languages, and associated collection references.
  - info:
      name: Create a site
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Creates a new site within an XM Cloud site collection. The site can be created from a template or as a blank site,
      and the request must specify the parent collection, name, and language configuration.
  - info:
      name: Get a site
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves a specific site by its unique identifier, including its full configuration, language settings, and collection
      membership.
  - info:
      name: Delete a site
      type: http
    http:
      method: DELETE
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Permanently deletes a site and all of its associated pages and content. This operation is irreversible and cannot
      be undone after execution.
  - info:
      name: Validate a site name
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/name/validate
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Validates whether a proposed site name is available and meets naming requirements prior to site creation. Returns
      validation status and error details if the name is unavailable or invalid.
  - info:
      name: Sort sites
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/sort
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Updates the sort order of sites as they appear in the Content Editor, Pages, and API responses. Accepts an ordered
      list of site identifiers.
  - info:
      name: List rendering hosts for a site
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId/renderinghosts
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Returns a list of editing hosts that can be assigned to the specified site. Rendering hosts define the front-end
      application endpoints used for Experience Editor and Pages rendering.
- info:
    name: Languages
    type: folder
  items:
  - info:
      name: List tenant languages
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/languages
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves all languages configured at the tenant level. Languages listed here are available for assignment to individual
      sites within the tenant.
  - info:
      name: List supported languages
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/languages/supported
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Returns all languages supported by the XM Cloud platform that can be added to a tenant or site configuration.
  - info:
      name: List site languages
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId/languages
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves all languages enabled for a specific site. These languages determine the locales in which content can
      be authored and delivered.
  - info:
      name: Add a language to a site
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId/languages
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Adds a language to a site, enabling content authoring and delivery in that locale. The language must be present
      in the list of supported languages before it can be added to a site.
  - info:
      name: Remove a language from a site
      type: http
    http:
      method: DELETE
      url: https://xmapps-api.sitecorecloud.io/api/v1/sites/:siteId/languages/:languageId
      params:
      - name: siteId
        value: ''
        type: path
        description: The unique identifier of the site
      - name: languageId
        value: ''
        type: path
        description: The language identifier (e.g., en, fr-FR)
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Removes a language from a site, preventing further content authoring in that locale. Existing content in the language
      is not deleted but becomes inaccessible through the site.
- info:
    name: Pages
    type: folder
  items:
  - info:
      name: List pages
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/pages
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      - name: siteId
        value: ''
        type: query
        description: Filter results by site identifier
      - name: language
        value: ''
        type: query
        description: Language code for the content (e.g., en, fr-FR)
    docs: Retrieves a list of pages for the specified site and environment. Supports filtering by language, version, and other
      attributes. Results are paginated and include basic page metadata.
  - info:
      name: Create a page
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/api/v1/pages
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Creates a new page within a site. Pages can be created from blueprints or as blank pages. The request must specify
      the parent item, page name, template, and optionally an insert options configuration.
  - info:
      name: Get a page
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/api/v1/pages/:pageId
      params:
      - name: pageId
        value: ''
        type: path
        description: The unique identifier of the page item
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      - name: language
        value: ''
        type: query
        description: Language code for the content (e.g., en, fr-FR)
      - name: version
        value: ''
        type: query
        description: Content version number to retrieve
    docs: Retrieves a specific page by its identifier. Returns full page metadata including layout information, version history,
      field values, and publishing state for the specified language and version.
  - info:
      name: Delete a page
      type: http
    http:
      method: DELETE
      url: https://xmapps-api.sitecorecloud.io/api/v1/pages/:pageId
      params:
      - name: pageId
        value: ''
        type: path
        description: The unique identifier of the page item
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Permanently deletes a page and all its versions and language variants. This operation is irreversible. Child pages
      are also deleted unless they are moved prior to deletion.
- info:
    name: Publishing Jobs
    type: folder
  items:
  - info:
      name: List publishing jobs
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/authoring/publishing/v1/jobs
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      - name: status
        value: ''
        type: query
        description: Filter jobs by status
      - name: pageSize
        value: ''
        type: query
        description: Number of jobs to return per page
    docs: Retrieves a paginated list of publishing jobs for the authenticated tenant and environment. Jobs can be filtered
      by status, date range, and other criteria. Returns job metadata including status, creation time, and item processing
      metrics.
  - info:
      name: Create a publishing job
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/authoring/publishing/v1/jobs
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
      body:
        type: json
        data: '{}'
    docs: Creates and queues a new publishing job to push content from XM Cloud authoring to the Experience Edge delivery
      layer. The job can target specific items, languages, or be configured as a full site publish.
  - info:
      name: Get a publishing job
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/authoring/publishing/v1/jobs/:id
      params:
      - name: jobId
        value: ''
        type: path
        description: The unique identifier of the publishing job
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves a specific publishing job by its identifier. Returns the current status, progress metrics, and any error
      information for the job.
  - info:
      name: Cancel a publishing job
      type: http
    http:
      method: POST
      url: https://xmapps-api.sitecorecloud.io/authoring/publishing/v1/jobs/:jobId/cancel
      params:
      - name: jobId
        value: ''
        type: path
        description: The unique identifier of the publishing job
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Cancels an active publishing job that is currently queued or running. Jobs in a terminal state (Completed, Failed,
      Canceled) cannot be cancelled. Returns the updated job with a Canceling or Canceled status.
  - info:
      name: Get publishing job summary
      type: http
    http:
      method: GET
      url: https://xmapps-api.sitecorecloud.io/authoring/publishing/v1/jobs/summary
      params:
      - name: sc_env
        value: ''
        type: query
        description: The XM Cloud environment identifier
    docs: Retrieves statistical summary information about publishing jobs within the tenant, including counts by status, recent
      activity metrics, and item processing totals.
bundled: true