Sitecore XM Cloud REST API — Sites

naftiko: 1.0.0-alpha2
info:
  label: Sitecore XM Cloud REST API — Sites
  description: 'Sitecore XM Cloud REST API — Sites. 7 operations. Lead operation: List sites. Self-contained Naftiko capability
    covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Sites
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: xm-cloud-rest-sites
    baseUri: https://xmapps-api.sitecorecloud.io
    description: Sitecore XM Cloud REST API — Sites business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-sites
      path: /api/v1/sites
      operations:
      - name: listsites
        method: GET
        description: List sites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collectionId
          in: query
          type: string
          description: Filter sites by parent collection identifier
      - name: createsite
        method: POST
        description: Create a site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-sites-name-validate
      path: /api/v1/sites/name/validate
      operations:
      - name: validatesitename
        method: POST
        description: Validate a site name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-sites-sort
      path: /api/v1/sites/sort
      operations:
      - name: sortsites
        method: POST
        description: Sort sites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-sites-siteId
      path: /api/v1/sites/{siteId}
      operations:
      - name: getsite
        method: GET
        description: Get a site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletesite
        method: DELETE
        description: Delete a site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-sites-siteId-renderinghosts
      path: /api/v1/sites/{siteId}/renderinghosts
      operations:
      - name: listsiterenderinghosts
        method: GET
        description: List rendering hosts for a site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SITECORE_API_KEY}}'
  exposes:
  - type: rest
    namespace: xm-cloud-rest-sites-rest
    port: 8080
    description: REST adapter for Sitecore XM Cloud REST API — Sites. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/sites
      name: api-v1-sites
      description: REST surface for api-v1-sites.
      operations:
      - method: GET
        name: listsites
        description: List sites
        call: xm-cloud-rest-sites.listsites
        with:
          collectionId: rest.collectionId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsite
        description: Create a site
        call: xm-cloud-rest-sites.createsite
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/sites/name/validate
      name: api-v1-sites-name-validate
      description: REST surface for api-v1-sites-name-validate.
      operations:
      - method: POST
        name: validatesitename
        description: Validate a site name
        call: xm-cloud-rest-sites.validatesitename
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/sites/sort
      name: api-v1-sites-sort
      description: REST surface for api-v1-sites-sort.
      operations:
      - method: POST
        name: sortsites
        description: Sort sites
        call: xm-cloud-rest-sites.sortsites
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/sites/{siteid}
      name: api-v1-sites-siteid
      description: REST surface for api-v1-sites-siteId.
      operations:
      - method: GET
        name: getsite
        description: Get a site
        call: xm-cloud-rest-sites.getsite
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesite
        description: Delete a site
        call: xm-cloud-rest-sites.deletesite
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/sites/{siteid}/renderinghosts
      name: api-v1-sites-siteid-renderinghosts
      description: REST surface for api-v1-sites-siteId-renderinghosts.
      operations:
      - method: GET
        name: listsiterenderinghosts
        description: List rendering hosts for a site
        call: xm-cloud-rest-sites.listsiterenderinghosts
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: xm-cloud-rest-sites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore XM Cloud REST API — Sites. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-sites
      description: List sites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: xm-cloud-rest-sites.listsites
      with:
        collectionId: tools.collectionId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-site
      description: Create a site
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: xm-cloud-rest-sites.createsite
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-site-name
      description: Validate a site name
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: xm-cloud-rest-sites.validatesitename
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sort-sites
      description: Sort sites
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: xm-cloud-rest-sites.sortsites
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-site
      description: Get a site
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: xm-cloud-rest-sites.getsite
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-site
      description: Delete a site
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: xm-cloud-rest-sites.deletesite
      outputParameters:
      - type: object
        mapping: $.
    - name: list-rendering-hosts-site
      description: List rendering hosts for a site
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: xm-cloud-rest-sites.listsiterenderinghosts
      outputParameters:
      - type: object
        mapping: $.