{"items":[{"type":"link","label":"Sites API","link":"/sai/sites-api","routeSlug":"/sai/sites-api","content":{"contentType":"overview","meta":{"name":"Sites API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/sai/sites-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/sai/sites-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Sites API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Sites API for managing sites, site collections and languages in the XM Apps system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API lets you interact with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Site Collection object. Use a site collection to group together related sites that share the same resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Site object. The site object is the core entity that represents a website in the customer portfolio."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Language object. The language object is used to manage the languages available to a tenant and site."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Job object. The job object is used to manage running background jobs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/getting-started-with-xm-cloud.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official SitecoreAI developer documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/sai/sites-api"}],"sectionId":"/sai/sites-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authorization"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authorize your requests, use environment automation client credentials and generate a JSON Web Token (JWT)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: To create client credentials, you must be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Organization Owner."},"children":[]}]}]}]}],"sectionId":"/sai/sites-api/section/authorization"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/create-an-automation-client"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an automation client"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Sitecore Cloud Portal, open SitecoreAI Deploy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fill out the automation client details, then click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the client ID and the client secret because you won't be able to view them again in SitecoreAI Deploy. You'll use them to request a JWT."},"children":[]}]}]}]}]}],"sectionId":"/sai/sites-api/section/authorization/create-an-automation-client"}],"sectionId":"/sai/sites-api/section/authorization/create-an-automation-client"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/request-a-jwt"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a JWT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run the following cURL command to request a JWT. Replace the placeholder values with your client ID and client secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key contains the JWT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JWT expires in 24 hours. If your requests unexpectedly return a response with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", request a new JWT by repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend that you cache the JWT for 24 hours to avoid repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request while the JWT is still valid."},"children":[]}]}]}]}],"sectionId":"/sai/sites-api/section/authorization/request-a-jwt"}],"sectionId":"/sai/sites-api/section/authorization/request-a-jwt"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/include-the-jwt-in-the-request-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the JWT in the request header"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now start making REST API requests. You must include the JWT in the request header of every request. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/...' \\\n-H 'Authorization: Bearer {YOUR_JWT}' \\\n-H 'Accept: application/json'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/...' \\\n-H 'Authorization: Bearer {YOUR_JWT}' \\\n-H 'Accept: application/json'\n"},"children":[]}]}]}],"sectionId":"/sai/sites-api/section/authorization/include-the-jwt-in-the-request-header"}],"sectionId":"/sai/sites-api/section/authorization/include-the-jwt-in-the-request-header"}]}]}},{"type":"group","label":"Authorization","link":"/sai/sites-api/section/authorization","routeSlug":"/sai/sites-api/section/authorization","items":[{"type":"link","label":"Create an automation client","link":"/sai/sites-api/section/authorization/create-an-automation-client","routeSlug":"/sai/sites-api/section/authorization/create-an-automation-client","content":null},{"type":"link","label":"Request a JWT","link":"/sai/sites-api/section/authorization/request-a-jwt","routeSlug":"/sai/sites-api/section/authorization/request-a-jwt","content":null},{"type":"link","label":"Include the JWT in the request header","link":"/sai/sites-api/section/authorization/include-the-jwt-in-the-request-header","routeSlug":"/sai/sites-api/section/authorization/include-the-jwt-in-the-request-header","content":null}],"content":null},{"type":"group","label":"Jobs","link":"/sai/sites-api/jobs","routeSlug":"/sai/sites-api/jobs","items":[{"label":"ListJobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/jobs/listjobs","routeSlug":"/sai/sites-api/jobs/listjobs","metadata":{"seo":{"title":"ListJobs","description":"Fetches information about background jobs. Returns empty array if no jobs are running."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListJobs","name":"ListJobs","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ListJobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about background jobs. Returns empty array if no jobs are running."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jobs","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/jobs","href":"jobs/listjobs","openApiOperationId":"ListJobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1363"}},"schemaId":"schema_1363"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1363"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/listjobs"}],"panels":[]}]},"httpPath":"/api/v1/jobs"},{"label":"RetrieveJob","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/jobs/retrievejob","routeSlug":"/sai/sites-api/jobs/retrievejob","metadata":{"seo":{"title":"RetrieveJob","description":"Fetches information about a background job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveJob","name":"RetrieveJob","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs~1{jobHandle}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RetrieveJob","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about a background job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobHandle","in":"path","schemaId":"schema_1364","required":true}],"pointer":"/paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jobs/{jobHandle}/status","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"jobHandle","in":"path","required":true,"schemaId":"schema_1364"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/v1/jobs/{jobHandle}/status","href":"jobs/retrievejob","openApiOperationId":"RetrieveJob"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/retrievejob"}],"panels":[]}]},"httpPath":"/api/v1/jobs/{jobHandle}/status"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"The Jobs API allows callers to manage running background jobs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jobs","summary":"ListJobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/listjobs","deprecated":false},{"title":"/api/v1/jobs/{jobHandle}/status","summary":"RetrieveJob","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/retrievejob","deprecated":false}]}]}]}]}},{"type":"group","label":"Collections","link":"/sai/sites-api/collections","routeSlug":"/sai/sites-api/collections","items":[{"label":"List site collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/listcollections","routeSlug":"/sai/sites-api/collections/listcollections","metadata":{"seo":{"title":"List site collections","description":"Fetches the list of site collections in the environment, with associated details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListCollections","name":"List site collections","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List site collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the list of site collections in the environment, with associated details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/collections","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/collections","href":"collections/listcollections","openApiOperationId":"ListCollections","summary":"List site collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1365"}},"schemaId":"schema_1365"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1365"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/listcollections"}],"panels":[]}]},"httpPath":"/api/v1/collections"},{"label":"Create a site collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/createcollection","routeSlug":"/sai/sites-api/collections/createcollection","metadata":{"seo":{"title":"Create a site collection","description":"Creates a collection by specifying a name and, optionally, a display name and description."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateCollection","name":"Create a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a collection by specifying a name and, optionally, a display name and description."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/CreateSiteCollectionInput"}},"schemaId":"components/schemas/CreateSiteCollectionInput","pointer":"/paths/~1api~1v1~1collections/post/requestBody","description":"Input data containing name and the description of the site collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/collections","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/CreateSiteCollectionInput"}},"responseCodes":["200","400"],"pointer":"/api/v1/collections","href":"collections/createcollection","openApiOperationId":"CreateCollection","summary":"Create a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CreateSiteCollectionInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/CreateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/CreateSiteCollectionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/createcollection"}],"panels":[]}]},"httpPath":"/api/v1/collections"},{"label":"Retrieve a site collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/retrievecollection","routeSlug":"/sai/sites-api/collections/retrievecollection","metadata":{"seo":{"title":"Retrieve a site collection","description":"Fetches information about a site collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveCollection","name":"Retrieve a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about a site collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1364","description":"The identifier of the site collection.","required":true,"example":"ff34f39f190b4079bf8a0242200b6780"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/collections/{collectionId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"example":"ff34f39f190b4079bf8a0242200b6780","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/collections/{collectionId}","href":"collections/retrievecollection","openApiOperationId":"RetrieveCollection","summary":"Retrieve a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCollection"}},"schemaId":"components/schemas/SiteCollection"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCollection"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/retrievecollection"}],"panels":[]}]},"httpPath":"/api/v1/collections/{collectionId}"},{"label":"Update a site collection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/updatecollection","routeSlug":"/sai/sites-api/collections/updatecollection","metadata":{"seo":{"title":"Update a site collection","description":"Updates the display name and the description of the site collection. To change the system name of a collection, see rename a site collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateCollection","name":"Update a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the display name and the description of the site collection. To change the system name of a collection, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Collections/operation/Rename"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rename a site collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1364","description":"The identifier of the site collection.","required":true,"example":"ff34f39f190b4079bf8a0242200b6780"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"}},"schemaId":"components/schemas/UpdateSiteCollectionInput","pointer":"/paths/~1api~1v1~1collections~1{collectionId}/patch/requestBody","description":"Input data containing name and the description of the site collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/collections/{collectionId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"example":"ff34f39f190b4079bf8a0242200b6780","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/collections/{collectionId}","href":"collections/updatecollection","openApiOperationId":"UpdateCollection","summary":"Update a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdateSiteCollectionInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteCollectionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCollection"}},"schemaId":"components/schemas/SiteCollection"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteCollection"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/updatecollection"}],"panels":[]}]},"httpPath":"/api/v1/collections/{collectionId}"},{"label":"Delete a site collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/deletecollection","routeSlug":"/sai/sites-api/collections/deletecollection","metadata":{"seo":{"title":"Delete a site collection","description":"Deletes a site collection, including sites in that collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCollection","name":"Delete a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a site collection, including sites in that collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1364","description":"The identifier of the site collection.","required":true,"example":"ff34f39f190b4079bf8a0242200b6780"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/collections/{collectionId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"example":"ff34f39f190b4079bf8a0242200b6780","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/collections/{collectionId}","href":"collections/deletecollection","openApiOperationId":"DeleteCollection","summary":"Delete a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/deletecollection"}],"panels":[]}]},"httpPath":"/api/v1/collections/{collectionId}"},{"label":"Rename a site collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/renamecollection","routeSlug":"/sai/sites-api/collections/renamecollection","metadata":{"seo":{"title":"Rename a site collection","description":"Changes the system name of a site collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RenameCollection","name":"Rename a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1rename/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes the system name of a site collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1364","description":"The identifier of the site collection.","required":true,"example":"ff34f39f190b4079bf8a0242200b6780"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteCollectionInput"}},"schemaId":"components/schemas/RenameSiteCollectionInput","pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1rename/post/requestBody","description":"Input object containing the new system name of the site collection."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/collections/{collectionId}/rename","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"example":"ff34f39f190b4079bf8a0242200b6780","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteCollectionInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/collections/{collectionId}/rename","href":"collections/renamecollection","openApiOperationId":"RenameCollection","summary":"Rename a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/RenameSiteCollectionInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"text/json":{"schemaId":"components/schemas/RenameSiteCollectionInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteCollectionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/renamecollection"}],"panels":[]}]},"httpPath":"/api/v1/collections/{collectionId}/rename"},{"label":"Sort site collections","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/sortcollections","routeSlug":"/sai/sites-api/collections/sortcollections","metadata":{"seo":{"title":"Sort site collections","description":"By assigning a sort value to site collection IDs, you can use this endpoint to apply an order by which collections are sorted in the Sites user interface and in Content Editor. The lower the sort value, the higher the site appears in the interface."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SortCollections","name":"Sort site collections","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1sort/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sort site collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"By assigning a sort value to site collection IDs, you can use this endpoint to apply an order by which collections are sorted in the Sites user interface and in Content Editor. The lower the sort value, the higher the site appears in the interface."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SortCollectionsInput"},"text/json":{"schemaId":"components/schemas/SortCollectionsInput"},"application/*+json":{"schemaId":"components/schemas/SortCollectionsInput"}},"schemaId":"components/schemas/SortCollectionsInput","pointer":"/paths/~1api~1v1~1collections~1sort/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON object of key-value pairs where the collection ID (string) is the key and the sort order (integer) is the value."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/collections/sort","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SortCollectionsInput"},"text/json":{"schemaId":"components/schemas/SortCollectionsInput"},"application/*+json":{"schemaId":"components/schemas/SortCollectionsInput"}},"responseCodes":["204","400","404"],"pointer":"/api/v1/collections/sort","href":"collections/sortcollections","openApiOperationId":"SortCollections","summary":"Sort site collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/SortCollectionsInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SortCollectionsInput"},"text/json":{"schemaId":"components/schemas/SortCollectionsInput"},"application/*+json":{"schemaId":"components/schemas/SortCollectionsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1sort/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/sortcollections"}],"panels":[]}]},"httpPath":"/api/v1/collections/sort"},{"label":"Validate site collection name","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/validatecollectionname","routeSlug":"/sai/sites-api/collections/validatecollectionname","metadata":{"seo":{"title":"Validate site collection name","description":"Validates a site collection name to ensure it meets the required criteria. The validations applied to the collection name:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ValidateCollectionName","name":"Validate site collection name","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1name~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate site collection name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates a site collection name to ensure it meets the required criteria. The validations applied to the collection name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is a string and can't be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the name is a maximum of 50 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can't start or end with a space."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can't start with a dash."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can include Latin alphanumeric characters, spaces and dashes."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1collections~1name~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"text/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateCollectionNameInput"}},"schemaId":"components/schemas/ValidateCollectionNameInput","pointer":"/paths/~1api~1v1~1collections~1name~1validate/post/requestBody","description":"The site collection name to validate."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/collections/name/validate","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"text/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateCollectionNameInput"}},"responseCodes":["200","400","503"],"pointer":"/api/v1/collections/name/validate","href":"collections/validatecollectionname","openApiOperationId":"ValidateCollectionName","summary":"Validate site collection name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/ValidateCollectionNameInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"text/json":{"schemaId":"components/schemas/ValidateCollectionNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateCollectionNameInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NameValidationResult"}},"schemaId":"components/schemas/NameValidationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example"]},{"code":"503","description":"Search service unavailable"}],"pointer":"/paths/~1api~1v1~1collections~1name~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NameValidationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NameValidationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example"]}}},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/validatecollectionname"}],"panels":[]}]},"httpPath":"/api/v1/collections/name/validate"},{"label":"List sites in a site collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/collections/listcollectionsites","routeSlug":"/sai/sites-api/collections/listcollectionsites","metadata":{"seo":{"title":"List sites in a site collection","description":"Fetches a list of sites in a site collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListCollectionSites","name":"List sites in a site collection","isWebhook":false,"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sites in a site collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of sites in a site collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1364","description":"The identifier of the site collection.","required":true,"example":"ff34f39f190b4079bf8a0242200b6780"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1sites/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/collections/{collectionId}/sites","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"example":"ff34f39f190b4079bf8a0242200b6780","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/collections/{collectionId}/sites","href":"collections/listcollectionsites","openApiOperationId":"ListCollectionSites","summary":"List sites in a site collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}},"schemaId":"schema_1366"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/listcollectionsites"}],"panels":[]}]},"httpPath":"/api/v1/collections/{collectionId}/sites"}],"content":{"contentType":"group","meta":{"name":"Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Collections API lets you group related sites together. The Collections API also lets authorized developers manage site collections."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/create-a-site-collection.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/collections","summary":"List site collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollections","deprecated":false},{"title":"/api/v1/collections","summary":"Create a site collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/createcollection","deprecated":false},{"title":"/api/v1/collections/{collectionId}","summary":"Retrieve a site collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/retrievecollection","deprecated":false},{"title":"/api/v1/collections/{collectionId}","summary":"Update a site collection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collections/updatecollection","deprecated":false},{"title":"/api/v1/collections/{collectionId}","summary":"Delete a site collection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections/deletecollection","deprecated":false},{"title":"/api/v1/collections/{collectionId}/rename","summary":"Rename a site collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/renamecollection","deprecated":false},{"title":"/api/v1/collections/sort","summary":"Sort site collections","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/sortcollections","deprecated":false},{"title":"/api/v1/collections/name/validate","summary":"Validate site collection name","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/validatecollectionname","deprecated":false},{"title":"/api/v1/collections/{collectionId}/sites","summary":"List sites in a site collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollectionsites","deprecated":false}]}]}]}]}},{"type":"group","label":"Favorites","link":"/sai/sites-api/favorites","routeSlug":"/sai/sites-api/favorites","items":[{"label":"List favorite sites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/getfavoritesites","routeSlug":"/sai/sites-api/favorites/getfavoritesites","metadata":{"seo":{"title":"List favorite sites","description":"Fetches a list of your favorite sites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFavoriteSites","name":"List favorite sites","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List favorite sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of your favorite sites"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1favorites~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/favorites/sites","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/favorites/sites","href":"favorites/getfavoritesites","openApiOperationId":"GetFavoriteSites","summary":"List favorite sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}},"schemaId":"schema_1366"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/getfavoritesites"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sites"},{"label":"Add a site to favorites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/addfavoritesite","routeSlug":"/sai/sites-api/favorites/addfavoritesite","metadata":{"seo":{"title":"Add a site to favorites","description":"Adds a site to your list of favorites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddFavoriteSite","name":"Add a site to favorites","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a site to favorites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a site to your list of favorites"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1favorites~1sites/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteInput"}},"schemaId":"components/schemas/AddFavoriteSiteInput","pointer":"/paths/~1api~1v1~1favorites~1sites/post/requestBody","description":"The input model."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/favorites/sites","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/favorites/sites","href":"favorites/addfavoritesite","openApiOperationId":"AddFavoriteSite","summary":"Add a site to favorites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/AddFavoriteSiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1364"}},"schemaId":"schema_1364"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sites/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1364"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/addfavoritesite"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sites"},{"label":"List favorite site templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/getfavoritesitetemplates","routeSlug":"/sai/sites-api/favorites/getfavoritesitetemplates","metadata":{"seo":{"title":"List favorite site templates","description":"Fetches a list of your favorite site templates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFavoriteSiteTemplates","name":"List favorite site templates","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List favorite site templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of your favorite site templates"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/favorites/sitetemplates","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/favorites/sitetemplates","href":"favorites/getfavoritesitetemplates","openApiOperationId":"GetFavoriteSiteTemplates","summary":"List favorite site templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1367"}},"schemaId":"schema_1367"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1367"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/getfavoritesitetemplates"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sitetemplates"},{"label":"Add a site template to favorites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/addfavoritesitetemplate","routeSlug":"/sai/sites-api/favorites/addfavoritesitetemplate","metadata":{"seo":{"title":"Add a site template to favorites","description":"Adds a site template to your list of favorites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddFavoriteSiteTemplate","name":"Add a site template to favorites","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a site template to favorites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a site template to your list of favorites"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"}},"schemaId":"components/schemas/AddFavoriteSiteTemplateInput","pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/post/requestBody","description":"The input model."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/favorites/sitetemplates","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"}},"responseCodes":["201","400","404"],"pointer":"/api/v1/favorites/sitetemplates","href":"favorites/addfavoritesitetemplate","openApiOperationId":"AddFavoriteSiteTemplate","summary":"Add a site template to favorites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/AddFavoriteSiteTemplateInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"text/json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"},"application/*+json":{"schemaId":"components/schemas/AddFavoriteSiteTemplateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FavoriteDto"}},"schemaId":"components/schemas/FavoriteDto"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/FavoriteDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FavoriteDto"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/addfavoritesitetemplate"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sitetemplates"},{"label":"Remove site from favorites","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/removefavoritesite","routeSlug":"/sai/sites-api/favorites/removefavoritesite","metadata":{"seo":{"title":"Remove site from favorites","description":"Removes a site from your list of favorites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RemoveFavoriteSite","name":"Remove site from favorites","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sites~1{siteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove site from favorites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a site from your list of favorites"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/favorites/sites/{siteId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/api/v1/favorites/sites/{siteId}","href":"favorites/removefavoritesite","openApiOperationId":"RemoveFavoriteSite","summary":"Remove site from favorites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/removefavoritesite"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sites/{siteId}"},{"label":"Remove a site template from favorites","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/favorites/removefavoritesitetemplate","routeSlug":"/sai/sites-api/favorites/removefavoritesitetemplate","metadata":{"seo":{"title":"Remove a site template from favorites","description":"Removes a site template from your list of favorites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RemoveFavoriteSiteTemplate","name":"Remove a site template from favorites","isWebhook":false,"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a site template from favorites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a site template from your list of favorites"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteTemplateId","in":"path","schemaId":"schema_1364","description":"The identifier of the site template.","required":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/favorites/sitetemplates/{siteTemplateId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteTemplateId","in":"path","required":true,"example":"5aae1eeaea2440bf96f11f43da82c77b","schemaId":"schema_1364"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/api/v1/favorites/sitetemplates/{siteTemplateId}","href":"favorites/removefavoritesitetemplate","openApiOperationId":"RemoveFavoriteSiteTemplate","summary":"Remove a site template from favorites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/favorites/removefavoritesitetemplate"}],"panels":[]}]},"httpPath":"/api/v1/favorites/sitetemplates/{siteTemplateId}"}],"content":{"contentType":"group","meta":{"name":"Favorites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Favorites","showPageActions":true},{"nodeType":"markdoc","content":"The Favorites API allows you to manage your list of favorite sites."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/favorites/sites","summary":"List favorite sites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/favorites/getfavoritesites","deprecated":false},{"title":"/api/v1/favorites/sites","summary":"Add a site to favorites","prefix":{"name":"post","color":"post"},"badges":[],"link":"/favorites/addfavoritesite","deprecated":false},{"title":"/api/v1/favorites/sitetemplates","summary":"List favorite site templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/favorites/getfavoritesitetemplates","deprecated":false},{"title":"/api/v1/favorites/sitetemplates","summary":"Add a site template to favorites","prefix":{"name":"post","color":"post"},"badges":[],"link":"/favorites/addfavoritesitetemplate","deprecated":false},{"title":"/api/v1/favorites/sites/{siteId}","summary":"Remove site from favorites","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/favorites/removefavoritesite","deprecated":false},{"title":"/api/v1/favorites/sitetemplates/{siteTemplateId}","summary":"Remove a site template from favorites","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/favorites/removefavoritesitetemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Languages","link":"/sai/sites-api/languages","routeSlug":"/sai/sites-api/languages","items":[{"label":"List languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/languages/listlanguages","routeSlug":"/sai/sites-api/languages/listlanguages","metadata":{"seo":{"title":"List languages","description":"Retrieves the list of languages added to the environment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListLanguages","name":"List languages","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of languages added to the environment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1languages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/languages","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/languages","href":"languages/listlanguages","openApiOperationId":"ListLanguages","summary":"List languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1368"}},"schemaId":"schema_1368"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1368"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/languages/listlanguages"}],"panels":[]}]},"httpPath":"/api/v1/languages"},{"label":"Add a language","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/languages/createlanguage","routeSlug":"/sai/sites-api/languages/createlanguage","metadata":{"seo":{"title":"Add a language","description":"Adds a language to your environment, so you can create content and build websites in that language. You can choose from the language supported by SitecoreAI. If you do not know the language code of the language, first retrieve the list of languages supported in SitecoreAI. To add a language to the system, you must provide the language code. You can optionally input additional parameters, such as region code and spell checker. If you want to add a custom language not in the default cultures, register it as a custom culture (as described in .NET CultureInfo class) and update the LanguageDefinitions.config file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateLanguage","name":"Add a language","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a language","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a language to your environment, so you can create content and build websites in that language. You can choose from the language supported by SitecoreAI. If you do not know the language code of the language, first retrieve the list of languages supported in SitecoreAI.\n            To add a language to the system, you must provide the language code. You can optionally input additional parameters, such as region code and spell checker.\n            If you want to add a custom language not in the default cultures, register it as a custom culture (as described in .NET CultureInfo class) and update the LanguageDefinitions.config file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1languages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddLanguageModel"},"text/json":{"schemaId":"components/schemas/AddLanguageModel"},"application/*+json":{"schemaId":"components/schemas/AddLanguageModel"}},"schemaId":"components/schemas/AddLanguageModel","pointer":"/paths/~1api~1v1~1languages/post/requestBody","description":"Input parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/languages","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddLanguageModel"},"text/json":{"schemaId":"components/schemas/AddLanguageModel"},"application/*+json":{"schemaId":"components/schemas/AddLanguageModel"}},"responseCodes":["200","400"],"pointer":"/api/v1/languages","href":"languages/createlanguage","openApiOperationId":"CreateLanguage","summary":"Add a language"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/AddLanguageModel","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddLanguageModel"},"text/json":{"schemaId":"components/schemas/AddLanguageModel"},"application/*+json":{"schemaId":"components/schemas/AddLanguageModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Language"}},"schemaId":"components/schemas/Language"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1languages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Language","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Language"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/languages/createlanguage"}],"panels":[]}]},"httpPath":"/api/v1/languages"},{"label":"List supported languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/languages/listsupportedlanguages","routeSlug":"/sai/sites-api/languages/listsupportedlanguages","metadata":{"seo":{"title":"List supported languages","description":"Retrieves the list of languages supported by SitecoreAI, and associated data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListSupportedLanguages","name":"List supported languages","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages~1supported/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List supported languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of languages supported by SitecoreAI, and associated data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1languages~1supported/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/languages/supported","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/languages/supported","href":"languages/listsupportedlanguages","openApiOperationId":"ListSupportedLanguages","summary":"List supported languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1369"}},"schemaId":"schema_1369"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1languages~1supported/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1369"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/languages/listsupportedlanguages"}],"panels":[]}]},"httpPath":"/api/v1/languages/supported"},{"label":"Update a language","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/languages/updatelanguage","routeSlug":"/sai/sites-api/languages/updatelanguage","metadata":{"seo":{"title":"Update a language","description":"Updates a language supported by SitecoreAI.To update a language, you must provide the regional ISO code of the language. If you do not know the ISO code of the language, first retrieve the list of languages supported in SitecoreAI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateLanguage","name":"Update a language","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a language","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/add-a-language-to-your-xm-cloud-environment.html#add-a-custom-language"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by SitecoreAI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a language, you must provide the regional ISO code of the language. If you do not know the ISO code of the language, first retrieve the list of languages supported in SitecoreAI."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"isoCode","in":"path","schemaId":"schema_1364","description":"Regional ISO code of the language to update","required":true,"example":"en-US"}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditLanguageInput"},"text/json":{"schemaId":"components/schemas/EditLanguageInput"},"application/*+json":{"schemaId":"components/schemas/EditLanguageInput"}},"schemaId":"components/schemas/EditLanguageInput","pointer":"/paths/~1api~1v1~1languages~1{isoCode}/patch/requestBody","description":"Input parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/languages/{isoCode}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"isoCode","in":"path","required":true,"example":"en-US","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditLanguageInput"},"text/json":{"schemaId":"components/schemas/EditLanguageInput"},"application/*+json":{"schemaId":"components/schemas/EditLanguageInput"}},"responseCodes":["204","400","404"],"pointer":"/api/v1/languages/{isoCode}","href":"languages/updatelanguage","openApiOperationId":"UpdateLanguage","summary":"Update a language"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/EditLanguageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditLanguageInput"},"text/json":{"schemaId":"components/schemas/EditLanguageInput"},"application/*+json":{"schemaId":"components/schemas/EditLanguageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Language","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Language","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Language","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Language","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/languages/updatelanguage"}],"panels":[]}]},"httpPath":"/api/v1/languages/{isoCode}"},{"label":"Delete a language","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/languages/deletelanguage","routeSlug":"/sai/sites-api/languages/deletelanguage","metadata":{"seo":{"title":"Delete a language","description":"Deletes a language from the SitecoreAI environment. To delete a language from the system, you must provide the regional ISO code of the language. If you do not know the ISO code of the language, first retrieve the list of languages added to the environment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteLanguage","name":"Delete a language","isWebhook":false,"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a language","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a language from the SitecoreAI environment.\n            To delete a language from the system, you must provide the regional ISO code of the language. If you do not know the ISO code of the language, first retrieve the list of languages added to the environment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"isoCode","in":"path","schemaId":"schema_1364","description":"Regional ISO code of the language to remove.","required":true,"example":"en-US"}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/languages/{isoCode}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"isoCode","in":"path","required":true,"example":"en-US","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/languages/{isoCode}","href":"languages/deletelanguage","openApiOperationId":"DeleteLanguage","summary":"Delete a language"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1370"}},"schemaId":"schema_1370"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1languages~1{isoCode}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1370"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/languages/deletelanguage"}],"panels":[]}]},"httpPath":"/api/v1/languages/{isoCode}"}],"content":{"contentType":"group","meta":{"name":"Languages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Languages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SitecoreAI supports creating content and websites in multiple languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default language is English, but you can "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/manage-languages-and-locales.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"add"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" any number of languages to your environment, languages that you can select amongst the predefined languages that are supported by SitecoreAI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sitecore supports all the languages available in the .NET CultureInfo class."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A predefined language in SitecoreAI follows the ISO code and combines both language and country or region, for example, en-AU or English(Australia)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/languages","summary":"List languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/languages/listlanguages","deprecated":false},{"title":"/api/v1/languages","summary":"Add a language","prefix":{"name":"post","color":"post"},"badges":[],"link":"/languages/createlanguage","deprecated":false},{"title":"/api/v1/languages/supported","summary":"List supported languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/languages/listsupportedlanguages","deprecated":false},{"title":"/api/v1/languages/{isoCode}","summary":"Update a language","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/languages/updatelanguage","deprecated":false},{"title":"/api/v1/languages/{isoCode}","summary":"Delete a language","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/languages/deletelanguage","deprecated":false}]}]}]}]}},{"type":"group","label":"Editor Profiles","link":"/sai/sites-api/editor-profiles","routeSlug":"/sai/sites-api/editor-profiles","items":[{"label":"List all profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/editor-profiles/listprofiles","routeSlug":"/sai/sites-api/editor-profiles/listprofiles","metadata":{"seo":{"title":"List all profiles","description":"Fetches a list of all profiles in the environment, with associated details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListProfiles","name":"List all profiles","isWebhook":false,"pointer":"/paths/~1api~1ui~1v1~1editorprofiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of all profiles in the environment, with associated details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/ui/v1/editorprofiles","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/ui/v1/editorprofiles","href":"editor-profiles/listprofiles","openApiOperationId":"ListProfiles","summary":"List all profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1371"}},"schemaId":"schema_1371"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1371","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1371"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/editor-profiles/listprofiles"}],"panels":[]}]},"httpPath":"/api/ui/v1/editorprofiles"},{"label":"Create a profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/editor-profiles/createprofile","routeSlug":"/sai/sites-api/editor-profiles/createprofile","metadata":{"seo":{"title":"Create a profile","description":"Creates a new profile in the environment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateProfile","name":"Create a profile","isWebhook":false,"pointer":"/paths/~1api~1ui~1v1~1editorprofiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new profile in the environment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/CreateEditorProfileInput"}},"schemaId":"components/schemas/CreateEditorProfileInput","pointer":"/paths/~1api~1ui~1v1~1editorprofiles/post/requestBody","description":"Input data containing profile properties"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/ui/v1/editorprofiles","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/CreateEditorProfileInput"}},"responseCodes":["201","400","401","403"],"pointer":"/api/ui/v1/editorprofiles","href":"editor-profiles/createprofile","openApiOperationId":"CreateProfile","summary":"Create a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CreateEditorProfileInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/CreateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/CreateEditorProfileInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}},"schemaId":"components/schemas/EditorProfileModel"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EditorProfileModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/editor-profiles/createprofile"}],"panels":[]}]},"httpPath":"/api/ui/v1/editorprofiles"},{"label":"Retrieve a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/editor-profiles/getprofile","routeSlug":"/sai/sites-api/editor-profiles/getprofile","metadata":{"seo":{"title":"Retrieve a profile","description":"Fetches the details of a profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProfile","name":"Retrieve a profile","isWebhook":false,"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the details of a profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1364","description":"The profile identifier.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/ui/v1/editorprofiles/{id}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1364"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/ui/v1/editorprofiles/{id}","href":"editor-profiles/getprofile","openApiOperationId":"GetProfile","summary":"Retrieve a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}},"schemaId":"components/schemas/EditorProfileModel"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EditorProfileModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/editor-profiles/getprofile"}],"panels":[]}]},"httpPath":"/api/ui/v1/editorprofiles/{id}"},{"label":"Update a profile","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/editor-profiles/updateprofile","routeSlug":"/sai/sites-api/editor-profiles/updateprofile","metadata":{"seo":{"title":"Update a profile","description":"Updates the properties of a profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateProfile","name":"Update a profile","isWebhook":false,"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the properties of a profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1364","description":"The profile identifier.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/UpdateEditorProfileInput"}},"schemaId":"components/schemas/UpdateEditorProfileInput","pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/requestBody","description":"Input data containing profile properties to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/ui/v1/editorprofiles/{id}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1364"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/UpdateEditorProfileInput"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/ui/v1/editorprofiles/{id}","href":"editor-profiles/updateprofile","openApiOperationId":"UpdateProfile","summary":"Update a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdateEditorProfileInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"text/json":{"schemaId":"components/schemas/UpdateEditorProfileInput"},"application/*+json":{"schemaId":"components/schemas/UpdateEditorProfileInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}},"schemaId":"components/schemas/EditorProfileModel"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EditorProfileModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EditorProfileModel"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/editor-profiles/updateprofile"}],"panels":[]}]},"httpPath":"/api/ui/v1/editorprofiles/{id}"},{"label":"Delete a profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/editor-profiles/deleteprofile","routeSlug":"/sai/sites-api/editor-profiles/deleteprofile","metadata":{"seo":{"title":"Delete a profile","description":"Deletes a profile, including the toolbar configuration associated with that profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteProfile","name":"Delete a profile","isWebhook":false,"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a profile, including the toolbar configuration associated with that profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1364","description":"The profile identifier.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/ui/v1/editorprofiles/{id}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1364"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404"],"pointer":"/api/ui/v1/editorprofiles/{id}","href":"editor-profiles/deleteprofile","openApiOperationId":"DeleteProfile","summary":"Delete a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/editor-profiles/deleteprofile"}],"panels":[]}]},"httpPath":"/api/ui/v1/editorprofiles/{id}"}],"content":{"contentType":"group","meta":{"name":"Editor Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Editor Profiles","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Editor Profiles API lets you manage which tools users can access in their page builder editor toolbar."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Editor Profiles API to create and manage editor profiles with configured tool sets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When editing in the page builder, the tools a user can access are based on the editor profile assigned to that site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To assign an editor profile to a site, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-docs.sitecore.com/sai/sites-api/sites/updatesite"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update that site"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on configuring an editor profile, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/sai/en/developers/sitecoreai/customize-the-rich-text-editor-toolbar.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customize the rich text editor toolbar"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/ui/v1/editorprofiles","summary":"List all profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/editor-profiles/listprofiles","deprecated":false},{"title":"/api/ui/v1/editorprofiles","summary":"Create a profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/editor-profiles/createprofile","deprecated":false},{"title":"/api/ui/v1/editorprofiles/{id}","summary":"Retrieve a profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/editor-profiles/getprofile","deprecated":false},{"title":"/api/ui/v1/editorprofiles/{id}","summary":"Update a profile","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/editor-profiles/updateprofile","deprecated":false},{"title":"/api/ui/v1/editorprofiles/{id}","summary":"Delete a profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/editor-profiles/deleteprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Sites","link":"/sai/sites-api/sites","routeSlug":"/sai/sites-api/sites","items":[{"label":"List sites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listsites","routeSlug":"/sai/sites-api/sites/listsites","metadata":{"seo":{"title":"List sites","description":"Fetches the list of sites in the environment, with associated details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListSites","name":"List sites","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the list of sites in the environment, with associated details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/sites","href":"sites/listsites","openApiOperationId":"ListSites","summary":"List sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}},"schemaId":"schema_1366"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listsites"}],"panels":[]}]},"httpPath":"/api/v1/sites"},{"label":"Create a site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/createsite","routeSlug":"/sai/sites-api/sites/createsite","metadata":{"seo":{"title":"Create a site","description":"Creates a site for the environment.Sites are created using  site templates. Every site belongs to a site collection. You can either create a site inside an existing collection or create a new one.It is also possible to create a site by duplicating a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateSite","name":"Create a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/create-a-site.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a site"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the environment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sites are created using  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/create-a-site-template-for-the-xm-cloud-dashboard.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every site belongs to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/create-a-site-collection.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can either create a site inside an existing collection or create a new one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is also possible to create a site by duplicating a site."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewSiteInput"},"text/json":{"schemaId":"components/schemas/NewSiteInput"},"application/*+json":{"schemaId":"components/schemas/NewSiteInput"}},"schemaId":"components/schemas/NewSiteInput","pointer":"/paths/~1api~1v1~1sites/post/requestBody","description":"Input model"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NewSiteInput"},"text/json":{"schemaId":"components/schemas/NewSiteInput"},"application/*+json":{"schemaId":"components/schemas/NewSiteInput"}},"responseCodes":["200","400"],"pointer":"/api/v1/sites","href":"sites/createsite","openApiOperationId":"CreateSite","summary":"Create a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/NewSiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NewSiteInput"},"text/json":{"schemaId":"components/schemas/NewSiteInput"},"application/*+json":{"schemaId":"components/schemas/NewSiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/createsite"}],"panels":[]}]},"httpPath":"/api/v1/sites"},{"label":"Retrieve a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievesite","routeSlug":"/sai/sites-api/sites/retrievesite","metadata":{"seo":{"title":"Retrieve a site","description":"Fetches information about a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveSite","name":"Retrieve a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}","href":"sites/retrievesite","openApiOperationId":"RetrieveSite","summary":"Retrieve a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}},"schemaId":"components/schemas/Site"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Site","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievesite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}"},{"label":"Update a site","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/updatesite","routeSlug":"/sai/sites-api/sites/updatesite","metadata":{"seo":{"title":"Update a site","description":"Updates various parameters of a site. To change the name of a site, see rename a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateSite","name":"Update a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates various parameters of a site. To change the name of a site, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Sites/operation/Rename"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rename a site"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSiteInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteInput"}},"schemaId":"components/schemas/UpdateSiteInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}/patch/requestBody","description":"Various site configuration properties"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/sites/{siteId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSiteInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}","href":"sites/updatesite","openApiOperationId":"UpdateSite","summary":"Update a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdateSiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSiteInput"},"text/json":{"schemaId":"components/schemas/UpdateSiteInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}},"schemaId":"components/schemas/Site"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Site","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/updatesite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}"},{"label":"Delete a site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/deletesite","routeSlug":"/sai/sites-api/sites/deletesite","metadata":{"seo":{"title":"Delete a site","description":"Deletes a site, including its pages, settings, media files, data sources, presentation elements, dictionaries, components, variants, and page designs. Everyone in the environment will lose access to the deleted site.Deleting a site affects related websites in the collection:• If the site shares items with other sites, this might result in broken links.• Items that are cloned to other sites are turned into regular items, and the links removed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSite","name":"Delete a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a site, including its pages, settings, media files, data sources, presentation elements, dictionaries, components, variants, and page designs. Everyone in the environment will lose access to the deleted site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a site affects related websites in the collection:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• If the site "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/create-a-site.html#share-a-site"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shares"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" items with other sites, this might result in broken links."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Items that are cloned to other sites are turned into regular items, and the links removed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_1370","description":"If this is set to true, the site will be deleted even if it is published to Edge.","example":false},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/sites/{siteId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"force","in":"query","example":false,"schemaId":"schema_1370"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}","href":"sites/deletesite","openApiOperationId":"DeleteSite","summary":"Delete a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/deletesite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}"},{"label":"Duplicate a site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/copysite","routeSlug":"/sai/sites-api/sites/copysite","metadata":{"seo":{"title":"Duplicate a site","description":"You can create a site by duplicating an existing one. When you duplicate a site, its content items (such as pages and images, folder structure, and links) are copied. Most of the settings are also copied, but you can change those later. The new site's path parameters and response body schema will be the same as the original site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CopySite","name":"Duplicate a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can create a site by duplicating an existing one. When you duplicate a site, its content items (such as pages and images, folder structure, and links) are copied. Most of the settings are also copied, but you can change those later. The new site's path parameters and response body schema will be the same as the original site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site you want to duplicate.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopySiteInput"},"text/json":{"schemaId":"components/schemas/CopySiteInput"},"application/*+json":{"schemaId":"components/schemas/CopySiteInput"}},"schemaId":"components/schemas/CopySiteInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1copy/post/requestBody","description":"Input object containing the name and description of the new site"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/{siteId}/copy","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CopySiteInput"},"text/json":{"schemaId":"components/schemas/CopySiteInput"},"application/*+json":{"schemaId":"components/schemas/CopySiteInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/copy","href":"sites/copysite","openApiOperationId":"CopySite","summary":"Duplicate a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CopySiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopySiteInput"},"text/json":{"schemaId":"components/schemas/CopySiteInput"},"application/*+json":{"schemaId":"components/schemas/CopySiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/copysite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/copy"},{"label":"Rename a site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/renamesite","routeSlug":"/sai/sites-api/sites/renamesite","metadata":{"seo":{"title":"Rename a site","description":"Changes the system name of a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RenameSite","name":"Rename a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1rename/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes the system name of a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site you want to rename.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameSiteInput"},"text/json":{"schemaId":"components/schemas/RenameSiteInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteInput"}},"schemaId":"components/schemas/RenameSiteInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1rename/post/requestBody","description":"Input object containing new name of the site"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/{siteId}/rename","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RenameSiteInput"},"text/json":{"schemaId":"components/schemas/RenameSiteInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/rename","href":"sites/renamesite","openApiOperationId":"RenameSite","summary":"Rename a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/RenameSiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameSiteInput"},"text/json":{"schemaId":"components/schemas/RenameSiteInput"},"application/*+json":{"schemaId":"components/schemas/RenameSiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/renamesite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/rename"},{"label":"Sort sites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/sortsites","routeSlug":"/sai/sites-api/sites/sortsites","metadata":{"seo":{"title":"Sort sites","description":"By assigning a sort value to site IDs, you can use this endpoint to apply an order by which sites are sorted in the Sites user interface and in Content Editor. The lower the sort value, the higher the site appears in the interface."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SortSites","name":"Sort sites","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1sort/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sort sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"By assigning a sort value to site IDs, you can use this endpoint to apply an order by which sites are sorted in the Sites user interface and in Content Editor. The lower the sort value, the higher the site appears in the interface."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1sort/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SortSitesInput"},"text/json":{"schemaId":"components/schemas/SortSitesInput"},"application/*+json":{"schemaId":"components/schemas/SortSitesInput"}},"schemaId":"components/schemas/SortSitesInput","pointer":"/paths/~1api~1v1~1sites~1sort/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON object of key-value pairs where the site ID (string) is the key and the sort order (integer) is the value."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/sort","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SortSitesInput"},"text/json":{"schemaId":"components/schemas/SortSitesInput"},"application/*+json":{"schemaId":"components/schemas/SortSitesInput"}},"responseCodes":["204","400","404"],"pointer":"/api/v1/sites/sort","href":"sites/sortsites","openApiOperationId":"SortSites","summary":"Sort sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/SortSitesInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SortSitesInput"},"text/json":{"schemaId":"components/schemas/SortSitesInput"},"application/*+json":{"schemaId":"components/schemas/SortSitesInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1sort/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/sortsites"}],"panels":[]}]},"httpPath":"/api/v1/sites/sort"},{"label":"Validate site name","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/validatesitename","routeSlug":"/sai/sites-api/sites/validatesitename","metadata":{"seo":{"title":"Validate site name","description":"Validates a site name to ensure it meets the required criteria. The validations applied to the site name:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ValidateSiteName","name":"Validate site name","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1name~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate site name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates a site name to ensure it meets the required criteria. The validations applied to the site name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is a string and can't be null."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the name is a maximum of 50 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can't start or end with a space."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can't start with a dash."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can include Latin alphanumeric characters, spaces and dashes."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1name~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"text/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateSiteNameInput"}},"schemaId":"components/schemas/ValidateSiteNameInput","pointer":"/paths/~1api~1v1~1sites~1name~1validate/post/requestBody","description":"The site name to validate."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/name/validate","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"text/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateSiteNameInput"}},"responseCodes":["200","400"],"pointer":"/api/v1/sites/name/validate","href":"sites/validatesitename","openApiOperationId":"ValidateSiteName","summary":"Validate site name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/ValidateSiteNameInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"text/json":{"schemaId":"components/schemas/ValidateSiteNameInput"},"application/*+json":{"schemaId":"components/schemas/ValidateSiteNameInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NameValidationResult"}},"schemaId":"components/schemas/NameValidationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1name~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NameValidationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NameValidationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/validatesitename"}],"panels":[]}]},"httpPath":"/api/v1/sites/name/validate"},{"label":"List sites that use an analytics identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listtrackedsites","routeSlug":"/sai/sites-api/sites/listtrackedsites","metadata":{"seo":{"title":"List sites that use an analytics identifier","description":"Fetches a list of sites that use an analytics identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListTrackedSites","name":"List sites that use an analytics identifier","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sites that use an analytics identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a list of sites that use an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/manage-personalization-and-analytics-for-sites.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"analytics identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"analyticsIdentifier","in":"path","schemaId":"schema_1364","description":"Analytics identifier.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"analyticsIdentifier","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}","href":"sites/listtrackedsites","openApiOperationId":"ListTrackedSites","summary":"List sites that use an analytics identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}},"schemaId":"schema_1366"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1366"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listtrackedsites"}],"panels":[]}]},"httpPath":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}"},{"label":"Unassign analytics identifiers from sites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/detachanalyticsidentifier","routeSlug":"/sai/sites-api/sites/detachanalyticsidentifier","metadata":{"seo":{"title":"Unassign analytics identifiers from sites","description":"Removes the analytics identifiers from one or more sites."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DetachAnalyticsIdentifier","name":"Unassign analytics identifiers from sites","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unassign analytics identifiers from sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the analytics identifiers from one or more sites."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"analyticsIdentifier","in":"path","schemaId":"schema_1364","description":"Analytics identifier.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"text/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"application/*+json":{"schemaId":"components/schemas/DetachFromSitesInput"}},"schemaId":"components/schemas/DetachFromSitesInput","pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/requestBody","description":"Input containing an array of site identifiers."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}/detach","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"analyticsIdentifier","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"text/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"application/*+json":{"schemaId":"components/schemas/DetachFromSitesInput"}},"responseCodes":["200","202","400","404"],"pointer":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}/detach","href":"sites/detachanalyticsidentifier","openApiOperationId":"DetachAnalyticsIdentifier","summary":"Unassign analytics identifiers from sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/DetachFromSitesInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"text/json":{"schemaId":"components/schemas/DetachFromSitesInput"},"application/*+json":{"schemaId":"components/schemas/DetachFromSitesInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1370"}},"schemaId":"schema_1370"},{"code":"202","description":"Accepted"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1370"}}},{"code":"202"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/detachanalyticsidentifier"}],"panels":[]}]},"httpPath":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}/detach"},{"label":"Retrieve the hierarchy of a site's main page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievesitehierarchy","routeSlug":"/sai/sites-api/sites/retrievesitehierarchy","metadata":{"seo":{"title":"Retrieve the hierarchy of a site's main page","description":"Fetches hierarchy information about the main page of a site, including its children, ancestors, and siblings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveSiteHierarchy","name":"Retrieve the hierarchy of a site's main page","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the hierarchy of a site's main page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches hierarchy information about the main page of a site, including its children, ancestors, and siblings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1364","description":"The ISO country-region language code for which to retrieve the hierarchy, for example: en-US, ar-AE.","example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hierarchy","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1364"}],"query":[{"name":"language","in":"query","example":"en-US","schemaId":"schema_1364"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/hierarchy","href":"sites/retrievesitehierarchy","openApiOperationId":"RetrieveSiteHierarchy","summary":"Retrieve the hierarchy of a site's main page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageHierarchy"}},"schemaId":"components/schemas/PageHierarchy"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageHierarchy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageHierarchy"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievesitehierarchy"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hierarchy"},{"label":"Retrieve the hierarchy of a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievepagehierarchy","routeSlug":"/sai/sites-api/sites/retrievepagehierarchy","metadata":{"seo":{"title":"Retrieve the hierarchy of a page","description":"Fetches hierarchy information about a page, including its children, ancestors, and siblings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrievePageHierarchy","name":"Retrieve the hierarchy of a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the hierarchy of a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches hierarchy information about a page, including its children, ancestors, and siblings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"pageId","in":"path","schemaId":"schema_1364","description":"Page identifier.","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1364","description":"The ISO country-region language code for which to retrieve the hierarchy, for example: en-US, ar-AE.","example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hierarchy/{pageId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1364"},{"name":"pageId","in":"path","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A","schemaId":"schema_1364"}],"query":[{"name":"language","in":"query","example":"en-US","schemaId":"schema_1364"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/hierarchy/{pageId}","href":"sites/retrievepagehierarchy","openApiOperationId":"RetrievePageHierarchy","summary":"Retrieve the hierarchy of a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageHierarchy"}},"schemaId":"components/schemas/PageHierarchy"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageHierarchy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageHierarchy"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievepagehierarchy"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hierarchy/{pageId}"},{"label":"List ancestors for a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listpageancestors","routeSlug":"/sai/sites-api/sites/listpageancestors","metadata":{"seo":{"title":"List ancestors for a page","description":"Fetches information about the ancestors of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPageAncestors","name":"List ancestors for a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ancestors for a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about the ancestors of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"pageId","in":"path","schemaId":"schema_1364","description":"Page identifier.","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1364","description":"The ISO country-region language code for which to retrieve the ancestors, for example: en-US, ar-AE.","example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hierarchy/{pageId}/ancestors","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1364"},{"name":"pageId","in":"path","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A","schemaId":"schema_1364"}],"query":[{"name":"language","in":"query","example":"en-US","schemaId":"schema_1364"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/sites/{siteId}/hierarchy/{pageId}/ancestors","href":"sites/listpageancestors","openApiOperationId":"ListPageAncestors","summary":"List ancestors for a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1372"}},"schemaId":"schema_1372"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1372"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listpageancestors"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hierarchy/{pageId}/ancestors"},{"label":"List children for a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listpagechildren","routeSlug":"/sai/sites-api/sites/listpagechildren","metadata":{"seo":{"title":"List children for a page","description":"Fetches information about the children of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPageChildren","name":"List children for a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List children for a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about the children of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"pageId","in":"path","schemaId":"schema_1364","description":"Page identifier.","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1364","description":"The ISO country-region language code for which to retrieve the children, for example: en-US, ar-AE.","example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hierarchy/{pageId}/children","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1364"},{"name":"pageId","in":"path","required":true,"example":"54106BDF-4C3C-4101-A07D-3BB41B63A76A","schemaId":"schema_1364"}],"query":[{"name":"language","in":"query","example":"en-US","schemaId":"schema_1364"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/sites/{siteId}/hierarchy/{pageId}/children","href":"sites/listpagechildren","openApiOperationId":"ListPageChildren","summary":"List children for a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1372"}},"schemaId":"schema_1372"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1372"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listpagechildren"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hierarchy/{pageId}/children"},{"label":"List hosts for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listhosts","routeSlug":"/sai/sites-api/sites/listhosts","metadata":{"seo":{"title":"List hosts for a site","description":"Retrieves the list of hosts for a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListHosts","name":"List hosts for a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List hosts for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of hosts for a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hosts","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/sites/{siteId}/hosts","href":"sites/listhosts","openApiOperationId":"ListHosts","summary":"List hosts for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1373"}},"schemaId":"schema_1373"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1373"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listhosts"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hosts"},{"label":"Create a site host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/createhost","routeSlug":"/sai/sites-api/sites/createhost","metadata":{"seo":{"title":"Create a site host","description":"Creates a host for a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateHost","name":"Create a site host","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a site host","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a host for a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateHostInput"},"text/json":{"schemaId":"components/schemas/CreateHostInput"},"application/*+json":{"schemaId":"components/schemas/CreateHostInput"}},"schemaId":"components/schemas/CreateHostInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/post/requestBody","description":"The parameters of a host."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/{siteId}/hosts","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateHostInput"},"text/json":{"schemaId":"components/schemas/CreateHostInput"},"application/*+json":{"schemaId":"components/schemas/CreateHostInput"}},"responseCodes":["201","400","409"],"pointer":"/api/v1/sites/{siteId}/hosts","href":"sites/createhost","openApiOperationId":"CreateHost","summary":"Create a site host"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CreateHostInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateHostInput"},"text/json":{"schemaId":"components/schemas/CreateHostInput"},"application/*+json":{"schemaId":"components/schemas/CreateHostInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Host"}},"schemaId":"components/schemas/Host"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Host","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Host"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/createhost"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hosts"},{"label":"Retrieve a site host by host ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievehost","routeSlug":"/sai/sites-api/sites/retrievehost","metadata":{"seo":{"title":"Retrieve a site host by host ID","description":"Fetches details about a site host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveHost","name":"Retrieve a site host by host ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a site host by host ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches details about a site host."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true},{"name":"hostId","in":"path","schemaId":"schema_1364","description":"The identifier of the host.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/hosts/{hostId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"},{"name":"hostId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/hosts/{hostId}","href":"sites/retrievehost","openApiOperationId":"RetrieveHost","summary":"Retrieve a site host by host ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Host"}},"schemaId":"components/schemas/Host"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Host","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Host"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievehost"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hosts/{hostId}"},{"label":"Update a host by host ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/updatehost","routeSlug":"/sai/sites-api/sites/updatehost","metadata":{"seo":{"title":"Update a host by host ID","description":"Modifies the properties of a host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateHost","name":"Update a host by host ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a host by host ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies the properties of a host."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true},{"name":"hostId","in":"path","schemaId":"schema_1364","description":"The identifier of the host.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateHostInput"},"text/json":{"schemaId":"components/schemas/UpdateHostInput"},"application/*+json":{"schemaId":"components/schemas/UpdateHostInput"}},"schemaId":"components/schemas/UpdateHostInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/requestBody","description":"New parameter values for the host."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/sites/{siteId}/hosts/{hostId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"},{"name":"hostId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateHostInput"},"text/json":{"schemaId":"components/schemas/UpdateHostInput"},"application/*+json":{"schemaId":"components/schemas/UpdateHostInput"}},"responseCodes":["204","400","404","409"],"pointer":"/api/v1/sites/{siteId}/hosts/{hostId}","href":"sites/updatehost","openApiOperationId":"UpdateHost","summary":"Update a host by host ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdateHostInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateHostInput"},"text/json":{"schemaId":"components/schemas/UpdateHostInput"},"application/*+json":{"schemaId":"components/schemas/UpdateHostInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/updatehost"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hosts/{hostId}"},{"label":"Delete a site host by host ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/deletehost","routeSlug":"/sai/sites-api/sites/deletehost","metadata":{"seo":{"title":"Delete a site host by host ID","description":"Deletes a site using a hostID. Deletes a site, including its pages, settings, media files, data sources, presentation elements, dictionaries, components, variants, and page designs. Everyone in the environment will lose access to the deleted site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteHost","name":"Delete a site host by host ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a site host by host ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a site using a hostID. Deletes a site, including its pages, settings, media files, data sources, presentation elements, dictionaries, components, variants, and page designs. Everyone in the environment will lose access to the deleted site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true},{"name":"hostId","in":"path","schemaId":"schema_1364","description":"The identifier of the host.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_1370","description":"If this is set to true, the host will be deleted even if it is published to Edge."},{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/sites/{siteId}/hosts/{hostId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"},{"name":"hostId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"force","in":"query","schemaId":"schema_1370"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["202","400","404"],"pointer":"/api/v1/sites/{siteId}/hosts/{hostId}","href":"sites/deletehost","openApiOperationId":"DeleteHost","summary":"Delete a site host by host ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/deletehost"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/hosts/{hostId}"},{"label":"List editing hosts for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/geteditinghosts","routeSlug":"/sai/sites-api/sites/geteditinghosts","metadata":{"seo":{"title":"List editing hosts for a site","description":"Fetches a list of editing hosts for a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetEditingHosts","name":"List editing hosts for a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List editing hosts for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of editing hosts for a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/editinghosts","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/editinghosts","href":"sites/geteditinghosts","openApiOperationId":"GetEditingHosts","summary":"List editing hosts for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1374"}},"schemaId":"schema_1374"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1374"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/geteditinghosts"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/editinghosts"},{"label":"List site templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/listsitetemplates","routeSlug":"/sai/sites-api/sites/listsitetemplates","metadata":{"seo":{"title":"List site templates","description":"Gets the site templates available in the environment that can be used for creating sites. Learn more about site templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListSiteTemplates","name":"List site templates","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List site templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the site templates available in the environment that can be used for creating sites. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/create-a-site-template-for-the-xm-cloud-dashboard.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/templates","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/v1/sites/templates","href":"sites/listsitetemplates","openApiOperationId":"ListSiteTemplates","summary":"List site templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1367"}},"schemaId":"schema_1367"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1367"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/listsitetemplates"}],"panels":[]}]},"httpPath":"/api/v1/sites/templates"},{"label":"Upload a thumbnail for a site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/uploadsitethumbnail","routeSlug":"/sai/sites-api/sites/uploadsitethumbnail","metadata":{"seo":{"title":"Upload a thumbnail for a site","description":"Uploads an image to be used as thumbnail for a site when it is displayed in the SitecoreAI Sites application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UploadSiteThumbnail","name":"Upload a thumbnail for a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a thumbnail for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads an image to be used as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/ea-xm-cloud/manage-sites.html#manage-general-site-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thumbnail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a site when it is displayed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/sites.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SitecoreAI Sites application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1375"}},"schemaId":"schema_1375","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/{siteId}/upload-thumbnail","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_1375"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/upload-thumbnail","href":"sites/uploadsitethumbnail","openApiOperationId":"UploadSiteThumbnail","summary":"Upload a thumbnail for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"schema_1375","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadMediaOutput"}},"schemaId":"components/schemas/UploadMediaOutput"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadMediaOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadMediaOutput"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/uploadsitethumbnail"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/upload-thumbnail"},{"label":"List localization statistics for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievelocalizationstatistics","routeSlug":"/sai/sites-api/sites/retrievelocalizationstatistics","metadata":{"seo":{"title":"List localization statistics for a site","description":"Fetches localization statistics for a site, including the number of pages in each locale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveLocalizationStatistics","name":"List localization statistics for a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List localization statistics for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches localization statistics for a site, including the number of pages in each locale."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The site identifier.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"Content Services environment identifier","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/statistics/localization","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404","503"],"pointer":"/api/v1/sites/{siteId}/statistics/localization","href":"sites/retrievelocalizationstatistics","openApiOperationId":"RetrieveLocalizationStatistics","summary":"List localization statistics for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalizationStatistics"}},"schemaId":"components/schemas/LocalizationStatistics"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example"]},{"code":"503","description":"Search service unavailable"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocalizationStatistics","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocalizationStatistics"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example"]}}},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievelocalizationstatistics"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/statistics/localization"},{"label":"Retrieve the sitemap configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrievesitemapconfiguration","routeSlug":"/sai/sites-api/sites/retrievesitemapconfiguration","metadata":{"seo":{"title":"Retrieve the sitemap configuration","description":"Fetches a sitemap configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveSitemapConfiguration","name":"Retrieve the sitemap configuration","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the sitemap configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/configure-a-sitemap.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sitemap"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The site identifier.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"Content Services environment identifier","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/configuration/sitemap","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/configuration/sitemap","href":"sites/retrievesitemapconfiguration","openApiOperationId":"RetrieveSitemapConfiguration","summary":"Retrieve the sitemap configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SitemapConfiguration"}},"schemaId":"components/schemas/SitemapConfiguration"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SitemapConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SitemapConfiguration"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrievesitemapconfiguration"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/configuration/sitemap"},{"label":"Update a sitemap configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/updatesitemapconfiguration","routeSlug":"/sai/sites-api/sites/updatesitemapconfiguration","metadata":{"seo":{"title":"Update a sitemap configuration","description":"Updates a sitemap configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateSitemapConfiguration","name":"Update a sitemap configuration","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a sitemap configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/configure-a-sitemap.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sitemap"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The site identifier.","required":true}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"Content Services environment identifier","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"text/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"}},"schemaId":"components/schemas/UpdateSitemapConfigurationInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/requestBody","description":"Configuration details of a sitemap."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/sites/{siteId}/configuration/sitemap","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"text/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/configuration/sitemap","href":"sites/updatesitemapconfiguration","openApiOperationId":"UpdateSitemapConfiguration","summary":"Update a sitemap configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdateSitemapConfigurationInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"text/json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"},"application/*+json":{"schemaId":"components/schemas/UpdateSitemapConfigurationInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SitemapConfiguration"}},"schemaId":"components/schemas/SitemapConfiguration"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SitemapConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SitemapConfiguration"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/updatesitemapconfiguration"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/configuration/sitemap"},{"label":"List workflow statistics for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/retrieveworkflowstatistics","routeSlug":"/sai/sites-api/sites/retrieveworkflowstatistics","metadata":{"seo":{"title":"List workflow statistics for a site","description":"Fetches the workflows defined for a site, their states, and the number of pages in each state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveWorkflowStatistics","name":"List workflow statistics for a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workflow statistics for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the workflows defined for a site, their states, and the number of pages in each state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The site identifier.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"Content Services environment identifier","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/statistics/workflow","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404","503"],"pointer":"/api/v1/sites/{siteId}/statistics/workflow","href":"sites/retrieveworkflowstatistics","openApiOperationId":"RetrieveWorkflowStatistics","summary":"List workflow statistics for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowsStatistics"}},"schemaId":"components/schemas/WorkflowsStatistics"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example"]},{"code":"503","description":"Search service unavailable"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowsStatistics","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowsStatistics"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example"]}}},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/retrieveworkflowstatistics"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/statistics/workflow"},{"label":"Translate a site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/translatesite","routeSlug":"/sai/sites-api/sites/translatesite","metadata":{"seo":{"title":"Translate a site","description":"Creates new translated versions of all items for a specific site using the Stream API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TranslateSite","name":"Translate a site","isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1translate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Translate a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates new translated versions of all items for a specific site using the Stream API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1translate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1translate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TranslateSiteInput"},"text/json":{"schemaId":"components/schemas/TranslateSiteInput"},"application/*+json":{"schemaId":"components/schemas/TranslateSiteInput"}},"schemaId":"components/schemas/TranslateSiteInput","pointer":"/paths/~1api~1v1~1sites~1{siteId}~1translate/post/requestBody","description":"The input model."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sites/{siteId}/translate","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TranslateSiteInput"},"text/json":{"schemaId":"components/schemas/TranslateSiteInput"},"application/*+json":{"schemaId":"components/schemas/TranslateSiteInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/translate","href":"sites/translatesite","openApiOperationId":"TranslateSite","summary":"Translate a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/TranslateSiteInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TranslateSiteInput"},"text/json":{"schemaId":"components/schemas/TranslateSiteInput"},"application/*+json":{"schemaId":"components/schemas/TranslateSiteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1364"}},"schemaId":"schema_1364"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1364"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/translatesite"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/translate"},{"label":"List rendering hosts for a site","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/sites-api/sites/getrenderinghosts","routeSlug":"/sai/sites-api/sites/getrenderinghosts","metadata":{"seo":{"title":"List rendering hosts for a site","description":"Deprecated: Use GetEditingHosts endpoint instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRenderingHosts","name":"List rendering hosts for a site","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rendering hosts for a site","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use GetEditingHosts endpoint instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a list of rendering hosts for a site."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_1364","description":"The identifier of the site.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1364","description":"The identifier of the environment","example":"main"}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/sites/{siteId}/renderinghosts","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1364"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/sites/{siteId}/renderinghosts","href":"sites/getrenderinghosts","openApiOperationId":"GetRenderingHosts","summary":"List rendering hosts for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1376"}},"schemaId":"schema_1376"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1376","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1376"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sites/getrenderinghosts"}],"panels":[]}]},"httpPath":"/api/v1/sites/{siteId}/renderinghosts"}],"content":{"contentType":"group","meta":{"name":"Sites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sites","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Sites API for managing sites, site collections and languages in the XM Apps system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API lets you interact with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Site Collection object. Use a site collection to group together related sites that share the same resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Site object. The site object is the core entity that represents a website in the customer portfolio."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Language object. The language object is used to manage the languages available to a tenant and site."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Job object. The job object is used to manage running background jobs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/getting-started-with-xm-cloud.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official SitecoreAI developer documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/sites","summary":"List sites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listsites","deprecated":false},{"title":"/api/v1/sites","summary":"Create a site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/createsite","deprecated":false},{"title":"/api/v1/sites/{siteId}","summary":"Retrieve a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievesite","deprecated":false},{"title":"/api/v1/sites/{siteId}","summary":"Update a site","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sites/updatesite","deprecated":false},{"title":"/api/v1/sites/{siteId}","summary":"Delete a site","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sites/deletesite","deprecated":false},{"title":"/api/v1/sites/{siteId}/copy","summary":"Duplicate a site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/copysite","deprecated":false},{"title":"/api/v1/sites/{siteId}/rename","summary":"Rename a site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/renamesite","deprecated":false},{"title":"/api/v1/sites/sort","summary":"Sort sites","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/sortsites","deprecated":false},{"title":"/api/v1/sites/name/validate","summary":"Validate site name","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/validatesitename","deprecated":false},{"title":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}","summary":"List sites that use an analytics identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listtrackedsites","deprecated":false},{"title":"/api/v1/sites/analytics-identifiers/{analyticsIdentifier}/detach","summary":"Unassign analytics identifiers from sites","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/detachanalyticsidentifier","deprecated":false},{"title":"/api/v1/sites/{siteId}/hierarchy","summary":"Retrieve the hierarchy of a site's main page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievesitehierarchy","deprecated":false},{"title":"/api/v1/sites/{siteId}/hierarchy/{pageId}","summary":"Retrieve the hierarchy of a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievepagehierarchy","deprecated":false},{"title":"/api/v1/sites/{siteId}/hierarchy/{pageId}/ancestors","summary":"List ancestors for a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listpageancestors","deprecated":false},{"title":"/api/v1/sites/{siteId}/hierarchy/{pageId}/children","summary":"List children for a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listpagechildren","deprecated":false},{"title":"/api/v1/sites/{siteId}/hosts","summary":"List hosts for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listhosts","deprecated":false},{"title":"/api/v1/sites/{siteId}/hosts","summary":"Create a site host","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/createhost","deprecated":false},{"title":"/api/v1/sites/{siteId}/hosts/{hostId}","summary":"Retrieve a site host by host ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievehost","deprecated":false},{"title":"/api/v1/sites/{siteId}/hosts/{hostId}","summary":"Update a host by host ID","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sites/updatehost","deprecated":false},{"title":"/api/v1/sites/{siteId}/hosts/{hostId}","summary":"Delete a site host by host ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sites/deletehost","deprecated":false},{"title":"/api/v1/sites/{siteId}/editinghosts","summary":"List editing hosts for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/geteditinghosts","deprecated":false},{"title":"/api/v1/sites/templates","summary":"List site templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/listsitetemplates","deprecated":false},{"title":"/api/v1/sites/{siteId}/upload-thumbnail","summary":"Upload a thumbnail for a site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/uploadsitethumbnail","deprecated":false},{"title":"/api/v1/sites/{siteId}/statistics/localization","summary":"List localization statistics for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievelocalizationstatistics","deprecated":false},{"title":"/api/v1/sites/{siteId}/configuration/sitemap","summary":"Retrieve the sitemap configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrievesitemapconfiguration","deprecated":false},{"title":"/api/v1/sites/{siteId}/configuration/sitemap","summary":"Update a sitemap configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sites/updatesitemapconfiguration","deprecated":false},{"title":"/api/v1/sites/{siteId}/statistics/workflow","summary":"List workflow statistics for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sites/retrieveworkflowstatistics","deprecated":false},{"title":"/api/v1/sites/{siteId}/translate","summary":"Translate a site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sites/translatesite","deprecated":false},{"title":"/api/v1/sites/{siteId}/renderinghosts","summary":"List rendering hosts for a site","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/sites/getrenderinghosts","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AddFavoriteSiteInput":{"id":"components/schemas/AddFavoriteSiteInput","kind":"json-schema","title":"AddFavoriteSiteInput","data":{"required":["favoriteSiteId"],"type":"object","properties":{"favoriteSiteId":{"minLength":1,"type":"string","description":"The site identifier.\nExample value: 110d559fdea542ea9c1c8a5df7e70ef9","example":"110d559fdea542ea9c1c8a5df7e70ef9"}},"additionalProperties":false,"description":"The details of the site to add to favorites."}},"components/schemas/AddFavoriteSiteTemplateInput":{"id":"components/schemas/AddFavoriteSiteTemplateInput","kind":"json-schema","title":"AddFavoriteSiteTemplateInput","data":{"required":["favoriteSiteTemplateId"],"type":"object","properties":{"favoriteSiteTemplateId":{"minLength":1,"type":"string","description":"The site template identifier.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","example":"5aae1eeaea2440bf96f11f43da82c77b"}},"additionalProperties":false,"description":"The details of the site template to add to favorites."}},"components/schemas/AddLanguageModel":{"id":"components/schemas/AddLanguageModel","kind":"json-schema","title":"AddLanguageModel","data":{"required":["languageCode"],"type":"object","properties":{"charset":{"type":"string","description":"The character encoding, that specifies how characters are represented in a document or web page.\nExample value: iso-8859-1","nullable":true,"example":"iso-8859-1"},"codePage":{"type":"string","description":"Code Page\nExample value: 65001","nullable":true,"example":"65001"},"customCode":{"type":"string","description":"If you wish to support a nonstandard country or region code, you can provide a custom language code.\nExample value: en-EU","nullable":true,"example":"en-EU"},"database":{"type":"string","description":"Database\nExample value: master","nullable":true,"example":"master"},"encoding":{"type":"string","description":"Encoding\nExample value: utf-8","nullable":true,"example":"utf-8"},"languageCode":{"minLength":1,"type":"string","description":"The ISO code for the language.\nExample value: en","example":"en"},"name":{"type":"string","description":"The name that will be used for the language.\nExample value: en-US","nullable":true,"example":"en-US"},"regionCode":{"type":"string","description":"The regional ISO code of the language. Example values: US for the USA, or DK for Denmark.\nExample value: US","nullable":true,"example":"US"},"fallbackLanguage":{"type":"string","description":"If you wish to configure fallback for the new language, add the ISO language code for the fallback language.\nExample value: en","nullable":true,"example":"en"},"spellChecker":{"type":"string","description":"A reference to the dictionary file name that you want to use to spellcheck in the new language.\nExample value: en-US.tdf","nullable":true,"example":"en-US.tdf"}},"additionalProperties":false}},"components/schemas/AnalyticsIdentifier":{"id":"components/schemas/AnalyticsIdentifier","kind":"json-schema","title":"AnalyticsIdentifier","data":{"required":["language","name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"The name of the analytics identifier.\nExample value: skate-park","example":"skate-park"},"language":{"minLength":1,"type":"string","description":"The language for the analytics identifier.\nExample value: en","example":"en"}},"additionalProperties":false,"description":"An Analytics tracker identifer for a site."}},"components/schemas/CopySiteInput":{"id":"components/schemas/CopySiteInput","kind":"json-schema","title":"CopySiteInput","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"Name for the new site.\nExample value: skate-park","default":"string","example":"skate-park"},"displayName":{"maxLength":100,"minLength":0,"type":"string","description":"Display name for the new site.\nExample value: Skate Park","nullable":true,"example":"Skate Park"},"description":{"maxLength":200,"minLength":0,"type":"string","description":"Description for the new site.\nExample value: Sample showcase website description.","nullable":true,"example":"Sample showcase website description."},"posMappings":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsIdentifier"},"description":"Analytics identifiers for the new site.","nullable":true}},"additionalProperties":false,"description":"A site duplication request."}},"components/schemas/CreateEditorProfileInput":{"id":"components/schemas/CreateEditorProfileInput","kind":"json-schema","title":"CreateEditorProfileInput","data":{"required":["name","value"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"The profile name\nExample value: Basic Editing","example":"Basic Editing"},"value":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The editor toolbar profile configuration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"toolbar\":{\"items\":[\"bold\",\"italic\",\"emphasis\",\"underline\",\"blockQuote\",{\"label\":\"Formatting\",\"icon\":\"text\",\"items\":[\"strikethrough\",\"subscript\",\"superscript\",\"|\",\"removeFormat\"]},\"fontColor\",\"fontBackgroundColor\",\"|\",\"heading\",\"|\",\"alignment\",\"bulletedList\",\"numberedList\",\"|\",\"outdent\",\"indent\",\"|\",\"link\",\"internalLink\",\"phoneLink\",\"|\",{\"label\":\"Insert\",\"withText\":false,\"icon\":\"plus\",\"items\":[\"sitecoreSelectMedia\",\"insertTable\",\"horizontalLine\"]},\"|\",\"sourceEditing\",\"|\",\"sitecoreResetFieldValue\"]}}"},"children":[]}]}]}],"example":"{\"toolbar\":{\"items\":[\"bold\",\"italic\",\"emphasis\",\"underline\",\"blockQuote\",{\"label\":\"Formatting\",\"icon\":\"text\",\"items\":[\"strikethrough\",\"subscript\",\"superscript\",\"|\",\"removeFormat\"]},\"fontColor\",\"fontBackgroundColor\",\"|\",\"heading\",\"|\",\"alignment\",\"bulletedList\",\"numberedList\",\"|\",\"outdent\",\"indent\",\"|\",\"link\",\"internalLink\",\"phoneLink\",\"|\",{\"label\":\"Insert\",\"withText\":false,\"icon\":\"plus\",\"items\":[\"sitecoreSelectMedia\",\"insertTable\",\"horizontalLine\"]},\"|\",\"sourceEditing\",\"|\",\"sitecoreResetFieldValue\"]}}"}},"additionalProperties":false,"description":"The profile creation request input"}},"components/schemas/CreateHostInput":{"id":"components/schemas/CreateHostInput","kind":"json-schema","title":"CreateHostInput","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The name of the new host.\nExample value: skate-park","default":"string","example":"skate-park"},"hostnames":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more hostnames."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"dev.skate-park.com\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"uat.skate-park.com\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["dev.skate-park.com","uat.skate-park.com"]},"targetHostname":{"type":"string","description":"The target hostname.\nExample value: www.skate-park.com","nullable":true,"example":"www.skate-park.com"},"renderingHost":{"type":"string","description":"The rendering host.\nExample value: Default","nullable":true,"example":"Default","deprecated":true},"editingHost":{"type":"string","description":"The rendering host.\nExample value: Default","nullable":true,"example":"Default"},"homePageId":{"pattern":"(?i)^(?:[({][0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]|[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12})$","type":"string","description":"The identifier of the home page.\nExample value: 110d559fdea542ea9c1c8a5df7e70ef9","nullable":true,"example":"110d559fdea542ea9c1c8a5df7e70ef9"},"thumbnail":{"type":"string","description":"The thumbnail information.","nullable":true},"analyticsIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsIdentifier"},"description":"The list of analytics tracker identifiers mapped to the host, per language.","nullable":true},"settings":{"type":"object","additionalProperties":{"type":"string"},"description":"The host settings collection.","nullable":true},"languageSettings":{"$ref":"#/components/schemas/SiteLanguageSettings"}},"additionalProperties":false,"description":"A host creation request"}},"components/schemas/CreateSiteCollectionInput":{"id":"components/schemas/CreateSiteCollectionInput","kind":"json-schema","title":"CreateSiteCollectionInput","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The unique system name of the new collection.\nExample value: skate-brand-sites","default":"string","example":"skate-brand-sites"},"displayName":{"maxLength":100,"minLength":0,"type":"string","description":"A short, meaningful name for the collection.\nExample value: Skate Brand Websites","nullable":true,"example":"Skate Brand Websites"},"description":{"maxLength":200,"minLength":0,"type":"string","description":"A longer, more detailed description of the collection.\nExample value: Collection for all Skate Park brand websites.","nullable":true,"example":"Collection for all Skate Park brand websites."}},"additionalProperties":false,"description":"A site collection creation request."}},"components/schemas/DetachFromSitesInput":{"id":"components/schemas/DetachFromSitesInput","kind":"json-schema","title":"DetachFromSitesInput","data":{"required":["sitesIdentifiers"],"type":"object","properties":{"sitesIdentifiers":{"type":"array","items":{"type":"string"},"description":"The list of sites, based on their identifier, for which the analytic identifier should be unassigned."}},"additionalProperties":false,"description":"Analytics identifier detach request."}},"components/schemas/EditLanguageInput":{"id":"components/schemas/EditLanguageInput","kind":"json-schema","title":"EditLanguageInput","data":{"type":"object","properties":{"languageCode":{"type":"string","nullable":true},"regionCode":{"type":"string","nullable":true},"fallbackLanguageIso":{"type":"string","nullable":true},"baseIsoCultureCode":{"type":"string","nullable":true},"fallbackRegionDisplayName":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/EditingHost":{"id":"components/schemas/EditingHost","kind":"json-schema","title":"EditingHost","data":{"type":"object","properties":{"id":{"type":"string","description":"The editing host ID.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"name":{"type":"string","description":"The name of the editing host.\nExample value: Default","nullable":true,"example":"Default"},"appName":{"type":"string","description":"The name of the app.\nExample value: Default","nullable":true,"example":"Default"},"layoutServiceConfiguration":{"type":"string","description":"The server side rendering engine configuration URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/config","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/config"},"serverSideRenderingEngineEndpointUrl":{"type":"string","description":"The server side rendering engine endpoint URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/render","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/render"},"serverSideRenderingEngineApplicationUrl":{"type":"string","description":"The server side rendering engine application URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io/","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io/"}},"additionalProperties":false,"description":"The editing host response entity."}},"components/schemas/EditorProfileModel":{"id":"components/schemas/EditorProfileModel","kind":"json-schema","title":"EditorProfileModel","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the profile.\nExample value: 123e4567-e89b-12d3-a456-426614174000","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"type":"string","description":"The name of the profile.\nExample value: Basic Editing","nullable":true,"example":"Basic Editing"},"profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tools configured for this profile."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"},"children":[]}]}]}],"nullable":true,"example":"{\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"}},"additionalProperties":false,"description":"The profile data model"}},"components/schemas/ErrorPage":{"id":"components/schemas/ErrorPage","kind":"json-schema","title":"ErrorPage","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the page.\nExample value: 68900348a3b84eb8ac7df4d179c25727","nullable":true,"example":"68900348a3b84eb8ac7df4d179c25727"},"path":{"type":"string","description":"The path for the page.\nExample value: Sitecore/Content/Home/Categories/Products/MyProduct","nullable":true,"example":"Sitecore/Content/Home/Categories/Products/MyProduct"}},"additionalProperties":false,"description":"The error page response entity."}},"components/schemas/ErrorPages":{"id":"components/schemas/ErrorPages","kind":"json-schema","title":"ErrorPages","data":{"type":"object","properties":{"errorPage":{"type":"string","description":"The identifier of the site's 500 error page. You can get page identifiers by calling the /hierarchy endpoint.\nExample value: c5a2fe31-46bd-34ae-91fb-d3c24b5a6e7f","nullable":true,"example":"c5a2fe31-46bd-34ae-91fb-d3c24b5a6e7f"},"notFoundPage":{"type":"string","description":"The identifier of the site's 404 error page. You can get page identifiers by calling the /hierarchy endpoint.\nExample value: a2fc5e31-6b4d-a43e-9f1b-c2d34b5a6e7f","nullable":true,"example":"a2fc5e31-6b4d-a43e-9f1b-c2d34b5a6e7f"}},"additionalProperties":false,"description":"An object containing the site error pages identifiers"}},"components/schemas/ErrorPagesConfiguration":{"id":"components/schemas/ErrorPagesConfiguration","kind":"json-schema","title":"ErrorPagesConfiguration","data":{"type":"object","properties":{"errorPage":{"$ref":"#/components/schemas/ErrorPage"},"notFoundPage":{"$ref":"#/components/schemas/ErrorPage"}},"additionalProperties":false,"description":"An object containing the site error pages"}},"components/schemas/FavoriteDto":{"id":"components/schemas/FavoriteDto","kind":"json-schema","title":"FavoriteDto","data":{"type":"object","properties":{"createdAt":{"type":"string","description":"The date and time when the favorite was created.","format":"date-time","nullable":true},"favoriteEntityId":{"type":"string","description":"The unique identifier of the favorited entity.\nExample value: 79d30e03fdaa44fda1aa03c731fe44e4","nullable":true,"example":"79d30e03fdaa44fda1aa03c731fe44e4"},"favoriteEntityType":{"type":"string","description":"The type of the favorited entity.\nExample value: Site","nullable":true,"example":"Site"}},"additionalProperties":false,"description":"Represents a data transfer object for a user's favorite entity."}},"components/schemas/Host":{"id":"components/schemas/Host","kind":"json-schema","title":"Host","data":{"type":"object","properties":{"id":{"type":"string","description":"The host ID.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"name":{"type":"string","description":"The name of the site host.\nExample value: skate-park","nullable":true,"example":"skate-park"},"hostnames":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more hostnames."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"dev.skate-park.com\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"uat.skate-park.com\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["dev.skate-park.com","uat.skate-park.com"]},"targetHostname":{"type":"string","description":"The target hostname.\nExample value: www.skate-park.com","nullable":true,"example":"www.skate-park.com"},"homePageId":{"type":"string","description":"The identifier of the home page.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"renderingHost":{"$ref":"#/components/schemas/RenderingHost"},"editingHost":{"$ref":"#/components/schemas/EditingHost"},"permissions":{"$ref":"#/components/schemas/Permissions"},"settings":{"type":"object","additionalProperties":{"type":"string"},"description":"The host settings collection.","nullable":true,"example":{"isSiteThumbnailSource":"true","sxaLinkable":"false"}},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Readonly host properties collection.","nullable":true,"example":{"siteDefinitionID":"{9004989A-E482-4587-B5C5-F9AECCD43565}","startItem":"/Home"}},"analyticsIdentifiers":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of analytics tracker identifiers mapped to the host, per language."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"name\": \"skate-park\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"language\": \"en-US\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":[{"name":"skate-park","language":"en-US"}]},"languageSettings":{"$ref":"#/components/schemas/SiteLanguageSettings"},"created":{"type":"string","description":"The date when the host was created.\nExample value: 2019-08-24T14:15:22Z","format":"date-time","nullable":true,"example":"2019-08-24T14:15:22Z"},"createdBy":{"type":"string","description":"The ID of the user who created the host.\nExample value: L6kfw52ZVf","nullable":true,"example":"L6kfw52ZVf"}},"additionalProperties":false,"description":"A host response entity"}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"done":{"type":"boolean","deprecated":true},"queueTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time","nullable":true},"handle":{"type":"string","nullable":true},"site":{"type":"string","nullable":true},"siteCollection":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/JobStatus"},"jobType":{"type":"string","nullable":true},"statistics":{"$ref":"#/components/schemas/JobStatisticsDto"}},"additionalProperties":false}},"components/schemas/JobResponse":{"id":"components/schemas/JobResponse","kind":"json-schema","title":"JobResponse","data":{"type":"object","properties":{"handle":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/JobStatisticsDto":{"id":"components/schemas/JobStatisticsDto","kind":"json-schema","title":"JobStatisticsDto","data":{"type":"object","properties":{"itemsProcessed":{"type":"integer","format":"int32","nullable":true},"pagesProcessed":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"enum":["Queued","Running","Completed","Failed"],"type":"string","format":"int32"}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the language.\nExample value: af58419145c9420187405409f4cf8bdd","nullable":true,"example":"af58419145c9420187405409f4cf8bdd"},"iso":{"type":"string","description":"The ISO code of the language.\nExample value: en","nullable":true,"example":"en"},"regionalIsoCode":{"type":"string","description":"The regional ISO code of the language, for example, US for the USA, or DK for Denmark.\nExample value: en-US","nullable":true,"example":"en-US"},"fallbackLanguageIso":{"type":"string","description":"The ISO code of the fallback language\nExample value: en","nullable":true,"example":"en"},"name":{"type":"string","description":"The ISO language code (e.g., \"en\" for English, \"es\" for Spanish).\nExample value: en-US","nullable":true,"example":"en-US"},"displayName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable name of the language as it appears in the user interface, for example, \"English\" or \"Español.\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: English (United States) : English (United States)"},"children":[]}]}]}],"nullable":true,"example":"English (United States) : English (United States)"},"nativeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language name in its original script or characters. For instance, \"English\" would be displayed as \"English\" itself, but \"日本語\" would appear as \"日本語.\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: English (United States)"},"children":[]}]}]}],"nullable":true,"example":"English (United States)"},"englishName":{"type":"string","description":"The language name in English, regardless of the language being described. For example, \"Deutsch\" would be displayed as \"German.\"\nExample value: English (United States)","nullable":true,"example":"English (United States)"},"baseIsoCultureCode":{"type":"string","description":"Base ISO culture code. If this is a custom language, this ISO culture code will represent the language code used as the base of this language.\nFor example, if the custom language uses the same writing system, calendar, and date format as American English, the value would be 'en-US'.\nExample value: en-US","nullable":true,"example":"en-US"},"fallbackRegionDisplayName":{"type":"string","description":"If this is a custom language, the Fallback Region Display Name respresents the region name that should be displayed.\nExample value: North America","nullable":true,"example":"North America"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"additionalProperties":false,"description":"Language"}},"components/schemas/LanguageData":{"id":"components/schemas/LanguageData","kind":"json-schema","title":"LanguageData","data":{"type":"object","properties":{"displayName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the language."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: Japanese (Japan) : 日本語 (日本)"},"children":[]}]}]}],"nullable":true,"example":"Japanese (Japan) : 日本語 (日本)"},"englishName":{"type":"string","description":"The language name in English, regardless of the language being described. For example, \"Deutsch\" would be displayed as \"German.\"\nExample value: English (United States)","nullable":true,"example":"English (United States)"},"locale":{"type":"string","description":"The language code of the locale.\nExample value: ja-JP","nullable":true,"example":"ja-JP"}},"additionalProperties":false,"description":"Data for the site locales."}},"components/schemas/LocaleStatistics":{"id":"components/schemas/LocaleStatistics","kind":"json-schema","title":"LocaleStatistics","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LanguageData"},"pageCount":{"type":"integer","description":"The number of pages in this locale.\nExample value: 60","format":"int32","example":60}},"additionalProperties":false,"description":"Represents the statistics for a locale."}},"components/schemas/LocalizationStatistics":{"id":"components/schemas/LocalizationStatistics","kind":"json-schema","title":"LocalizationStatistics","data":{"type":"object","properties":{"locales":{"type":"array","items":{"$ref":"#/components/schemas/LocaleStatistics"},"description":"A collection of locales defined for the site and their statistics.","nullable":true},"totalPageCount":{"type":"integer","description":"The total number of pages across all locales.\nExample value: 60","format":"int32","example":60}},"additionalProperties":false,"description":"Represents the localization statistics for a site."}},"components/schemas/NameValidationResult":{"id":"components/schemas/NameValidationResult","kind":"json-schema","title":"NameValidationResult","data":{"type":"object","properties":{"isValid":{"type":"boolean","description":"Whether the name is valid."},"message":{"type":"string","description":"Details about the request.","nullable":true}},"additionalProperties":false}},"components/schemas/NewSiteInput":{"id":"components/schemas/NewSiteInput","kind":"json-schema","title":"NewSiteInput","data":{"required":["language","siteName","templateId"],"type":"object","properties":{"siteName":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The name of the site.\nExample value: skate-park","default":"string","example":"skate-park"},"displayName":{"maxLength":100,"minLength":0,"type":"string","description":"The display name for the site.\nExample value: Skate Park Site","nullable":true,"example":"Skate Park Site"},"templateId":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the template used to create the site. If you don't know the template ID, first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Sites/operation/GetTemplates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve site templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: 5aae1eeaea2440bf96f11f43da82c77b"},"children":[]}]}]}],"example":"5aae1eeaea2440bf96f11f43da82c77b"},"collectionId":{"pattern":"(?i)^(?:[({][0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]|[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12})$|(?i)^[0-9A-Z]{22}$","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the collection you want the new site to belong to. If you don't know the collection ID, first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Collections/operation/Get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if Sitecore.XmApps.Sites.Models.REST.NewSiteInput.CollectionName is not provided. If left empty, you must provide collectionName instead and a new collection will be created along with the newly created site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both collectionId and collectionName are provided, collectionName will be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: 5aae1eeaea2440bf96f11f43da82c77b"},"children":[]}]}]}],"nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language for the site. If you do not know what languages are available in the environment, first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Languages/operation/Get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve the list of languages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the language you want is not available in the environment, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Languages/operation/Create"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"add the language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: en"},"children":[]}]}]}],"example":"en"},"languages":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of supported languages for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"da\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["en","da"]},"hostName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional hostname for the new site. Default value: *"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: dev.skate-park.com"},"children":[]}]}]}],"nullable":true,"example":"dev.skate-park.com"},"description":{"maxLength":200,"minLength":0,"type":"string","description":"Optional text that provides a meaningful description of the site.\nExample value: New site for Brand A in English-speaking countries.","nullable":true,"example":"New site for Brand A in English-speaking countries."},"collectionName":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The name of the new collection you want the new site to belong to.\nRequired if Sitecore.XmApps.Sites.Models.REST.NewSiteInput.CollectionId is not provided. If left empty, you must provide collectionId of an existing collection you want the new site to belong to.\nIf both collectionId and collectionName are provided, collectionName will be ignored.\nExample value: Brand A","nullable":true,"example":"Brand A"},"collectionDisplayName":{"maxLength":100,"minLength":0,"type":"string","description":"The display name for the collection.\nExample value: Skate Park Site","nullable":true,"example":"Skate Park Site"},"collectionDescription":{"maxLength":100,"minLength":0,"type":"string","description":"If you want to create a new site collection while creating a new site, you can provide a collection description.\nExample value: Sample description for the site collection containing Sites for Brand A","nullable":true,"example":"Sample description for the site collection containing Sites for Brand A"},"posMappings":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsIdentifier"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/manage-personalization-and-analytics-for-sites.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This identifier lets you control analytics and personalization for the site."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"A site creation request."}},"components/schemas/PageHierarchy":{"id":"components/schemas/PageHierarchy","kind":"json-schema","title":"PageHierarchy","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageResponse"},"children":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"description":"Details of this page's children.","nullable":true},"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"description":"Details of this page's ancestors.","nullable":true},"siblings":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"description":"Details of this page's siblings.","nullable":true}},"additionalProperties":false,"description":"Page hierarchy response entity."}},"components/schemas/PageInsertOption":{"id":"components/schemas/PageInsertOption","kind":"json-schema","title":"PageInsertOption","data":{"type":"object","properties":{"id":{"type":"string","description":"Template ID\nExample value: 6fe7d655-1e3d-4c27-8010-5777f06c6c4f","nullable":true,"example":"6fe7d655-1e3d-4c27-8010-5777f06c6c4f"},"displayName":{"type":"string","description":"Template display name\nExample value: Page","nullable":true,"example":"Page"},"templateType":{"$ref":"#/components/schemas/TemplateType"}},"additionalProperties":false}},"components/schemas/PageLocking":{"id":"components/schemas/PageLocking","kind":"json-schema","title":"PageLocking","data":{"type":"object","properties":{"canUnlock":{"type":"boolean","description":"Whether the current user can unlock the page for editing.\nExample value: False","example":false},"isLocked":{"type":"boolean","description":"Whether the page is currently locked for editing.\nExample value: False","example":false},"lockedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the page is locked, the user who locked it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: john.smith@skate-park.com"},"children":[]}]}]}],"nullable":true,"example":"john.smith@skate-park.com"},"lockedByCurrentUser":{"type":"boolean","description":"Whether the page was locked by the current user.\nExample value: False","example":false}},"additionalProperties":false}},"components/schemas/PageResponse":{"id":"components/schemas/PageResponse","kind":"json-schema","title":"PageResponse","data":{"type":"object","properties":{"insertOptions":{"type":"array","items":{"$ref":"#/components/schemas/PageInsertOption"},"description":"Insert options for the page.","nullable":true},"hasVersions":{"type":"boolean","description":"Whether the page has versions in the queried language.\nExample value: True","example":true},"children":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"description":"Children of the page.","nullable":true},"id":{"type":"string","description":"The page identifier.\nExample value: 68900348a3b84eb8ac7df4d179c25727","nullable":true,"example":"68900348a3b84eb8ac7df4d179c25727"},"name":{"type":"string","description":"The page's system name.\nExample value: Home","nullable":true,"example":"Home"},"displayName":{"type":"string","description":"The page's display name.\nExample value: Site Home","nullable":true,"example":"Site Home"},"language":{"type":"string","description":"The page language.\nExample value: en-US","nullable":true,"example":"en-US"},"version":{"type":"integer","description":"The current version of the page.\nExample value: 1","format":"int32","example":1},"templateId":{"type":"string","description":"The identifier of the template this page is based on.\nExample value: 6fe7d6551e3d4c2780105777f06c6c4f","nullable":true,"example":"6fe7d6551e3d4c2780105777f06c6c4f"},"parentId":{"type":"string","description":"The identifier of the page's parent.\nExample value: 4bc0c81a280b4b13890b7b074b9d68f4","nullable":true,"example":"4bc0c81a280b4b13890b7b074b9d68f4"},"hasPresentation":{"type":"boolean","description":"If set to true, this page can be rendered in the SitecoreAI Pages application. This value is automatically set to false for the root item of the site, as well as for the folders if there are any.\nExample value: True","example":true},"hasChildren":{"type":"boolean","description":"Whether the page has any child pages.\nExample value: True","example":true},"isLatestPublishableVersion":{"type":"boolean","description":"Whether the page version is latest publishable version\nExample value: True","example":true},"permissions":{"$ref":"#/components/schemas/Permissions"},"locking":{"$ref":"#/components/schemas/PageLocking"},"path":{"type":"string","description":"The path for the page.\nExample value: Sitecore/Content/Home/Categories/Products/MyProduct","nullable":true,"example":"Sitecore/Content/Home/Categories/Products/MyProduct"},"route":{"type":"string","description":"The public-facing URL path relative to the site's root.\nExample value: /Aboutus","nullable":true,"example":"/Aboutus"}},"additionalProperties":false}},"components/schemas/Permissions":{"id":"components/schemas/Permissions","kind":"json-schema","title":"Permissions","data":{"type":"object","properties":{"canAdmin":{"type":"boolean","description":"Whether the current user has admin rights. Being an admin means that you control access permissions for other users, and have full read and write rights.\nExample value: False","example":false},"canWrite":{"type":"boolean","description":"Whether the current user has permissions to edit values. Users with write access also have read access.\nExample value: False","example":false},"canCreate":{"type":"boolean","description":"Whether the current user has permission to create entities.\nExample value: False","example":false},"canDelete":{"type":"boolean","description":"Whether the current user has permission to delete entities.\nExample value: False","example":false},"canRename":{"type":"boolean","description":"Whether the current user has permission to rename entities.\nExample value: False","example":false},"canRead":{"type":"boolean","description":"Whether the current user has permission to see entities, including all their parameters.\nExample value: False","example":false},"canPublish":{"type":"boolean","description":"Whether the current user has permission to publish sites in this environment.\nExample value: False","example":false},"canDuplicate":{"type":"boolean","description":"Whether the current user has permission to duplicate entities.\nExample value: False","example":false},"canWriteLanguage":{"type":"boolean","description":"Whether the current user has permission to write item language entities.\nExample value: False","example":false}},"additionalProperties":false,"description":"The access rights of the current user to the site."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of the error response entity.","nullable":true},"title":{"type":"string","description":"The title of the error response entity.","nullable":true},"status":{"type":"integer","description":"The response status code.","format":"int32","nullable":true},"detail":{"type":"string","description":"A detailed explanation, specific to this occurrence of the problem.","nullable":true},"instance":{"type":"string","description":"If available, a URI reference that identifies the specific occurrence of the problem.","nullable":true}},"additionalProperties":{"description":"Any additional optional properties that describe the error(s)."}}},"components/schemas/RenameSiteCollectionInput":{"id":"components/schemas/RenameSiteCollectionInput","kind":"json-schema","title":"RenameSiteCollectionInput","data":{"required":["systemName"],"type":"object","properties":{"systemName":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The new system name for the site collection.\nExample value: skate-brand-sites","default":"string","example":"skate-brand-sites"}},"additionalProperties":false,"description":"Site collection rename request."}},"components/schemas/RenameSiteInput":{"id":"components/schemas/RenameSiteInput","kind":"json-schema","title":"RenameSiteInput","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"The new name for the site.\nExample value: new-site","default":"string","example":"new-site"}},"additionalProperties":false,"description":"A site rename request."}},"components/schemas/RenderingHost":{"id":"components/schemas/RenderingHost","kind":"json-schema","title":"RenderingHost","data":{"type":"object","properties":{"id":{"type":"string","description":"The rendering host ID.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"name":{"type":"string","description":"The name of the rendering host.\nExample value: Default","nullable":true,"example":"Default"},"appName":{"type":"string","description":"The name of the app.\nExample value: Default","nullable":true,"example":"Default"},"layoutServiceConfiguration":{"type":"string","description":"The server side rendering engine configuration URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/config","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/config"},"serverSideRenderingEngineEndpointUrl":{"type":"string","description":"The server side rendering engine endpoint URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/render","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io:443/api/editing/render"},"serverSideRenderingEngineApplicationUrl":{"type":"string","description":"The server side rendering engine application URL.\nExample value: https://xmc-eh-uniqueid.sitecorecloud.io/","nullable":true,"example":"https://xmc-eh-uniqueid.sitecorecloud.io/"}},"additionalProperties":false,"description":"The rendering host response entity."}},"components/schemas/Site":{"id":"components/schemas/Site","kind":"json-schema","title":"Site","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the site.\nExample value: 497f6eca-6276-4993-bfeb-53cbbbba6f08","nullable":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"name":{"type":"string","description":"The name of the site.\nExample value: skate-park","nullable":true,"example":"skate-park"},"description":{"type":"string","description":"The description of the site.\nExample value: New site for Brand A in English-speaking countries","nullable":true,"example":"New site for Brand A in English-speaking countries"},"displayName":{"type":"string","description":"The display name of the site.\nExample value: Skate Park Website","nullable":true,"example":"Skate Park Website"},"thumbnail":{"$ref":"#/components/schemas/Thumbnail"},"collectionId":{"type":"string","description":"The identifier of the collection to which the site belongs.\nExample value: 5aae1eeaea2440bf96f11f43da82c77b","nullable":true,"example":"5aae1eeaea2440bf96f11f43da82c77b"},"created":{"type":"string","description":"The date when the site was created.\nExample value: 2019-08-24T14:15:22Z","format":"date-time","example":"2019-08-24T14:15:22Z"},"createdBy":{"type":"string","description":"The ID of the user who created the site.\nExample value: L6kfw52ZVf","nullable":true,"example":"L6kfw52ZVf"},"sortOrder":{"type":"integer","description":"Sort order of the site.\nExample value: 100","format":"int32","nullable":true,"example":100},"brandKitId":{"type":"string","description":"The identifier of the brand kit associated with this site.\nExample value: e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f","nullable":true,"example":"e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f"},"permissions":{"$ref":"#/components/schemas/Permissions"},"languages":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of languages in use by the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-US\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-CA\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["en-US","en-CA"]},"hosts":{"type":"array","items":{"$ref":"#/components/schemas/Host"},"description":"The list of hosts that the site resolves to.","nullable":true},"supportedLanguages":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of languages supported by Sitecore."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-US\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-CA\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["en-US","en-CA"]},"errorPages":{"$ref":"#/components/schemas/ErrorPages"},"errorPagesConfiguration":{"$ref":"#/components/schemas/ErrorPagesConfiguration"},"settings":{"type":"object","additionalProperties":{"type":"string"},"description":"The settings for the site.","nullable":true,"example":{"thumbnailsRootPath":"/sitecore/media library/Project/sample-collection/sample-site","generateThumbnails":"true"}},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The read-only properties of the site.","nullable":true,"example":{"SxaSiteTemplate":"{E46F3AF2-39FA-4866-A157-7017C4B2A40C}","IsSxaSite":"true"}}},"additionalProperties":false,"description":"A site response entity."}},"components/schemas/SiteCollection":{"id":"components/schemas/SiteCollection","kind":"json-schema","title":"SiteCollection","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the site collection.\nExample value: 497f6eca-6276-4993-bfeb-53cbbbba6f08","nullable":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"name":{"type":"string","description":"The unique system name of the site collection.\nExample value: skate-park-sites","nullable":true,"example":"skate-park-sites"},"description":{"type":"string","description":"The description of the site collection.\nExample value: Collection for all Skate Park brand websites.","nullable":true,"example":"Collection for all Skate Park brand websites."},"displayName":{"type":"string","description":"The display name of the site collection.\nExample value: Skate Park Websites","nullable":true,"example":"Skate Park Websites"},"sortOrder":{"type":"integer","description":"Sort order of the site collection.\nExample value: 100","format":"int32","nullable":true,"example":100},"createdBy":{"type":"string","description":"The ID of the user who created the site collection.\nExample value: L6kfw52ZVf","nullable":true,"example":"L6kfw52ZVf"},"created":{"type":"string","description":"The date when the site collection was created.\nExample value: 2019-08-24T14:15:22Z","format":"date-time","example":"2019-08-24T14:15:22Z"},"permissions":{"$ref":"#/components/schemas/Permissions"},"settings":{"type":"object","additionalProperties":{"type":"string"},"description":"The site collection settings.","nullable":true,"example":{"itemPath":"/sitecore/content/skate-park-sites"}}},"additionalProperties":false,"description":"Site collection response entity."}},"components/schemas/SiteLanguageSettings":{"id":"components/schemas/SiteLanguageSettings","kind":"json-schema","title":"SiteLanguageSettings","data":{"type":"object","properties":{"defaultLanguage":{"type":"string","description":"The default language.\nExample value: en","nullable":true,"example":"en"},"languageEmbedding":{"type":"boolean","description":"Whether language embedding is enabled.\nExample value: False","nullable":true,"example":false},"itemLanguageFallback":{"type":"boolean","description":"Whether item language fallback is enabled.\nExample value: False","nullable":true,"example":false},"fieldLanguageFallback":{"type":"boolean","description":"Whether field language fallback is enabled.\nExample value: False","nullable":true,"example":false}},"additionalProperties":false,"description":"The language settings of the host."}},"components/schemas/SiteTemplate":{"id":"components/schemas/SiteTemplate","kind":"json-schema","title":"SiteTemplate","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the site template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {5AAE1EEA-EA24-40BF-96F1-1F43DA82C77B}"},"children":[]}]}]}],"nullable":true,"example":"{5AAE1EEA-EA24-40BF-96F1-1F43DA82C77B}"},"name":{"type":"string","description":"The name of the site template.\nExample value: Basic","nullable":true,"example":"Basic"},"enabled":{"type":"boolean","description":"Whether the template is available for use in the SitecoreAI Create a site UI.\nExample value: True","example":true},"description":{"type":"string","description":"The description of the site template.\nExample value: An example of a simple website with homepage, subpage, navigation, and footer.","nullable":true,"example":"An example of a simple website with homepage, subpage, navigation, and footer."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"description":"The summary of what pages, components, or integrations are included in the template.","nullable":true},"createdBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The author of the site template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: sitecore\\L6kfw52Vf"},"children":[]}]}]}],"nullable":true,"example":"sitecore\\L6kfw52Vf"},"updatedOn":{"type":"string","description":"The date of the last update.\nExample value: 2019-08-24T14:15:22Z","format":"date-time","example":"2019-08-24T14:15:22Z"},"thumbnail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The thumbnail of the site template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: https://customer-tenant.sitecorecloud.io/-/media/Feature/JSS-Experience-Accelerator/Basic-Site/template-thumbnail.png?w=176"},"children":[]}]}]}],"nullable":true,"example":"https://customer-tenant.sitecorecloud.io/-/media/Feature/JSS-Experience-Accelerator/Basic-Site/template-thumbnail.png?w=176"},"image":{"type":"string","description":"Large resolution screenshot of the site template.\nExample value: https://customer-tenant.sitecorecloud.io/-/media/Feature/JSS-Experience-Accelerator/Basic-Site/template-thumbnail.png","nullable":true,"example":"https://customer-tenant.sitecorecloud.io/-/media/Feature/JSS-Experience-Accelerator/Basic-Site/template-thumbnail.png"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"The site template metadata.","nullable":true,"example":{"builtInTemplate":"true"}}},"additionalProperties":false,"description":"Site template response entity."}},"components/schemas/SitemapAlternateLinksOptions":{"id":"components/schemas/SitemapAlternateLinksOptions","kind":"json-schema","title":"SitemapAlternateLinksOptions","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether alternate link generation is enabled. When enabled, xhtml:link elements are added to the URL elements in the sitemap.\nExample value: True","nullable":true,"example":true},"includeXDefault":{"type":"boolean","description":"Whether alternate links include an x-default link element. The x-default value signals to the search algorithm that the page does not target any specific language or region.\nExample value: True","nullable":true,"example":true}},"additionalProperties":false,"description":"Alternate link sitemap configuration."}},"components/schemas/SitemapCacheOptions":{"id":"components/schemas/SitemapCacheOptions","kind":"json-schema","title":"SitemapCacheOptions","data":{"type":"object","properties":{"refreshThreshold":{"type":"string","description":"Threshold in minutes for refreshing the sitemap cache.\nExample value: 60","nullable":true,"example":"60"}},"additionalProperties":false,"description":"Sitemap caching configuration."}},"components/schemas/SitemapConfiguration":{"id":"components/schemas/SitemapConfiguration","kind":"json-schema","title":"SitemapConfiguration","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the sitemap configuration item.\nExample value: 2905a9c7-30b0-4d3f-bced-f1f9382c8041","nullable":true,"example":"2905a9c7-30b0-4d3f-bced-f1f9382c8041"},"enabled":{"type":"boolean","description":"Whether sitemap generation is enabled.\nExample value: True","nullable":true,"example":true},"maxNumberOfPages":{"type":"string","description":"Maximum number of pages to include in a single sitemap file.\nExample value: 1000","nullable":true,"example":"1000"},"alternateLinksOptions":{"$ref":"#/components/schemas/SitemapAlternateLinksOptions"},"urlOptions":{"$ref":"#/components/schemas/SitemapUrlOptions"},"cacheOptions":{"$ref":"#/components/schemas/SitemapCacheOptions"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"additionalProperties":false,"description":"Configuration settings for sitemap generation."}},"components/schemas/SitemapUrlOptions":{"id":"components/schemas/SitemapUrlOptions","kind":"json-schema","title":"SitemapUrlOptions","data":{"type":"object","properties":{"includeChangeFreq":{"type":"boolean","description":"Whether to include change frequency attribute in the sitemap, that specifies how often the page changes its content.\nExample value: True","nullable":true,"example":true},"includeLastMod":{"type":"boolean","description":"Whether to include the last modification date in the sitemap.\nExample value: True","nullable":true,"example":true},"includePriority":{"type":"boolean","description":"Whether to include priority information in the sitemap. The priority is a number between 0 and 1 that represents the importance of a page.\nExample value: True","nullable":true,"example":true}},"additionalProperties":false,"description":"URL property configurations in the sitemap."}},"components/schemas/SortCollectionsInput":{"id":"components/schemas/SortCollectionsInput","kind":"json-schema","title":"SortCollectionsInput","data":{"type":"object","properties":{"collections":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"A collection containing collection IDs and sort order.","nullable":true,"example":{"{E7ACF719-9448-4B82-B9E9-E35E612392B1}":0,"{3BB5127B-9B19-479E-A560-DDAB73050C0D}":100,"{1E3D6D62-2EE7-4B99-B973-9C861E535236}":200}}},"additionalProperties":false,"description":"Sort collections request."}},"components/schemas/SortSitesInput":{"id":"components/schemas/SortSitesInput","kind":"json-schema","title":"SortSitesInput","data":{"type":"object","properties":{"sites":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"A collection containing site IDs and sort order.","nullable":true,"example":{"{43550C6A-2FFF-4DE6-B773-9133CEAF9099}":0,"{258D18A4-B06B-4CE6-95A7-C0D78574552B}":100,"{2C6B1648-E371-43B4-80F5-FAF4ECA43E48}":200}}},"additionalProperties":false,"description":"Sort sites request."}},"components/schemas/StringStringKeyValuePair":{"id":"components/schemas/StringStringKeyValuePair","kind":"json-schema","title":"StringStringKeyValuePair","data":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/SupportedLanguage":{"id":"components/schemas/SupportedLanguage","kind":"json-schema","title":"SupportedLanguage","data":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the language.\nExample value: de-DE","nullable":true,"example":"de-DE"},"englishName":{"type":"string","description":"The english name of the language.\nExample value: German (Germany)","nullable":true,"example":"German (Germany)"},"displayName":{"type":"string","description":"The display name of the language.\nExample value: German (Germany) : Deutsch (Deutschland)","nullable":true,"example":"German (Germany) : Deutsch (Deutschland)"},"charSet":{"type":"string","description":"The character encoding, that specifies how characters are represented in a document or web page.\nExample value: iso-8859-1","nullable":true,"example":"iso-8859-1"},"codePage":{"type":"string","description":"The code of the page.\nExample value: 65001","nullable":true,"example":"65001"},"encoding":{"type":"string","description":"The encoding.\nExample value: utf-8","nullable":true,"example":"utf-8"},"languageCode":{"type":"string","description":"The code for the language.\nExample value: de","nullable":true,"example":"de"},"regionCode":{"type":"string","description":"The regional ISO code of the language. For example, US for the USA, or DK for Denmark.\nExample value: DE","nullable":true,"example":"DE"}},"additionalProperties":false}},"components/schemas/TemplateType":{"id":"components/schemas/TemplateType","kind":"json-schema","title":"TemplateType","data":{"enum":["ItemTemplate","BranchTemplate"],"type":"string","description":"The type of template."}},"components/schemas/Thumbnail":{"id":"components/schemas/Thumbnail","kind":"json-schema","title":"Thumbnail","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the image used as thumbnail."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: https://xmc-customer-tenant.sitecorecloud.io/-/media/Project/sample-collection/sample-site/System/7/0/B/C/thumbnail_70BC64BDE257400E82BFDB3344797DB7.png"},"children":[]}]}]}],"nullable":true,"example":"https://xmc-customer-tenant.sitecorecloud.io/-/media/Project/sample-collection/sample-site/System/7/0/B/C/thumbnail_70BC64BDE257400E82BFDB3344797DB7.png"},"rootPath":{"type":"string","description":"The path to the media folder where thumbnail images are stored.\nExample value: sitecore/media library/Project/sample-collection/sample-site","nullable":true,"example":"sitecore/media library/Project/sample-collection/sample-site"},"autogenerated":{"type":"boolean","description":"Whether the thumbnail was autogenerated or manually uploaded.\nExample value: True","example":true}},"additionalProperties":false,"description":"The thumbnail response entity."}},"components/schemas/TranslateSiteInput":{"id":"components/schemas/TranslateSiteInput","kind":"json-schema","title":"TranslateSiteInput","data":{"required":["sourceLanguage","targetLanguage","translationStrategy"],"type":"object","properties":{"sourceLanguage":{"minLength":1,"type":"string","description":"Source language\nExample value: en","example":"en"},"targetLanguage":{"minLength":1,"type":"string","description":"Target language\nExample value: ja-JP","example":"ja-JP"},"translationStrategy":{"$ref":"#/components/schemas/TranslationStrategy"}},"additionalProperties":false,"description":"The translations options"}},"components/schemas/TranslationStrategy":{"id":"components/schemas/TranslationStrategy","kind":"json-schema","title":"TranslationStrategy","data":{"enum":["AddVersion","SkipIfExists"],"type":"string","description":"Specifies the strategy to use when translating: add a new version or skip if a version exists.","format":"int32"}},"components/schemas/UpdateEditorProfileInput":{"id":"components/schemas/UpdateEditorProfileInput","kind":"json-schema","title":"UpdateEditorProfileInput","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the profile.\nExample value: Advanced Editing","nullable":true,"example":"Advanced Editing"},"profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tools configured for this profile."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"},"children":[]}]}]}],"nullable":true,"example":"{\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"}},"additionalProperties":false,"description":"The profile update request input"}},"components/schemas/UpdateHostInput":{"id":"components/schemas/UpdateHostInput","kind":"json-schema","title":"UpdateHostInput","data":{"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"pattern":"^(?![\\s-])[a-zA-Z0-9_\\s-]*(?<!\\s)$","type":"string","description":"Name of the host\nExample value: skate-park","default":"string","nullable":true,"example":"skate-park"},"hostnames":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more hostnames."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"dev.skate-park.com\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"uat.skate-park.com\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["dev.skate-park.com","uat.skate-park.com"]},"targetHostname":{"type":"string","description":"The target hostname.\nExample value: www.skate-park.com","nullable":true,"example":"www.skate-park.com"},"renderingHost":{"type":"string","description":"The rendering host.\nExample value: Default","nullable":true,"example":"Default","deprecated":true},"editingHost":{"type":"string","description":"The rendering host.\nExample value: Default","nullable":true,"example":"Default"},"homePageId":{"pattern":"(?i)^(?:[({][0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]|[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12})$","type":"string","description":"The identifier of the home page.\nExample value: 110d559fdea542ea9c1c8a5df7e70ef9","nullable":true,"example":"110d559fdea542ea9c1c8a5df7e70ef9"},"thumbnail":{"type":"string","description":"The thumbnail information.","nullable":true},"analyticsIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsIdentifier"},"description":"The list of analytics tracker identifiers mapped to the host, per language.","nullable":true},"settings":{"type":"object","additionalProperties":{"type":"string"},"description":"The host settings collection.","nullable":true},"languageSettings":{"$ref":"#/components/schemas/SiteLanguageSettings"}},"additionalProperties":false,"description":"A host update request."}},"components/schemas/UpdateSiteCollectionInput":{"id":"components/schemas/UpdateSiteCollectionInput","kind":"json-schema","title":"UpdateSiteCollectionInput","data":{"type":"object","properties":{"displayName":{"maxLength":100,"minLength":0,"type":"string","description":"The display name for the site collection.\nExample value: Skate Brand Websites","default":"string","nullable":true,"example":"Skate Brand Websites"},"description":{"maxLength":200,"minLength":0,"type":"string","description":"The description of the site collection.\nExample value: Example site collection description.","default":"string","nullable":true,"example":"Example site collection description."},"sortOrder":{"type":"integer","description":"The sort order of the site collection.\nExample value: 100","format":"int32","nullable":true,"example":100}},"additionalProperties":false,"description":"Update site collection request"}},"components/schemas/UpdateSiteInput":{"id":"components/schemas/UpdateSiteInput","kind":"json-schema","title":"UpdateSiteInput","data":{"type":"object","properties":{"displayName":{"maxLength":100,"minLength":0,"type":"string","description":"The display name for the site.\nExample value: Skate Park Site","default":"string","nullable":true,"example":"Skate Park Site"},"description":{"maxLength":200,"minLength":0,"type":"string","description":"The description for the site.\nExample value: New site for Brand A in English-speaking countries.","default":"string","nullable":true,"example":"New site for Brand A in English-speaking countries."},"supportedLanguages":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of languages supported by Sitecore."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-US\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"en-CA\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["en-US","en-CA"]},"shared":{"type":"boolean","description":"Whether the site should be marked as shared or not. True - site will be shared. False - site will not be marked as shared.\nExample value: True","nullable":true,"example":true},"errorPages":{"$ref":"#/components/schemas/ErrorPages"},"sortOrder":{"type":"integer","description":"The sort order of the site.\nExample value: 100","format":"int32","nullable":true,"example":100},"targetHostname":{"type":"string","description":"The target hostname of the site.\nExample value: skatepark.local","nullable":true,"example":"skatepark.local","deprecated":true},"brandKitId":{"type":"string","description":"The identifier of the brand kit associated with this site.\nExample value: e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f","nullable":true,"example":"e3f1c5a2-4b6d-4a3e-9f1b-2d3c4b5a6e7f"},"resetThumbnail":{"type":"boolean","description":"Whether the thumbnail should be reset. True - thumbnail will be reset to automatic. False - thumbnail will not be reset.\nExample value: True","nullable":true,"example":true},"editorProfiles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of text editor profiles associated with the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"e2102e93-424a-4a99-a066-7750dbf41b28\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"530f7907-6eec-4b7a-9fcc-98aef2719232\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["e2102e93-424a-4a99-a066-7750dbf41b28","530f7907-6eec-4b7a-9fcc-98aef2719232"]}},"additionalProperties":false,"description":"A site update request."}},"components/schemas/UpdateSitemapConfigurationInput":{"id":"components/schemas/UpdateSitemapConfigurationInput","kind":"json-schema","title":"UpdateSitemapConfigurationInput","data":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"pattern":"(?i)^(?:[({][0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]|[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12})$","type":"string","description":"The identifier of the sitemap configuration item.\nExample value: da570793-3539-4923-88ca-8314ddd193f7","example":"da570793-3539-4923-88ca-8314ddd193f7"},"enabled":{"type":"boolean","description":"Whether sitemap generation is enabled.\nExample value: True","nullable":true,"example":true},"maxNumberOfPages":{"type":"string","description":"Maximum number of pages to include in a single sitemap file.\nExample value: 1000","nullable":true,"example":"1000"},"alternateLinksOptions":{"$ref":"#/components/schemas/SitemapAlternateLinksOptions"},"urlOptions":{"$ref":"#/components/schemas/SitemapUrlOptions"},"cacheOptions":{"$ref":"#/components/schemas/SitemapCacheOptions"}},"additionalProperties":false,"description":"A sitemap configuration update request"}},"components/schemas/UploadMediaOutput":{"id":"components/schemas/UploadMediaOutput","kind":"json-schema","title":"UploadMediaOutput","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The thumbnail image ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {5AAE1EEA-EA24-40BF-96F1-1F43DA82C77B}"},"children":[]}]}]}],"nullable":true,"example":"{5AAE1EEA-EA24-40BF-96F1-1F43DA82C77B}"},"name":{"type":"string","description":"Name of the uploaded image.\nExample value: skate-park-screenshot","nullable":true,"example":"skate-park-screenshot"},"itemPath":{"type":"string","description":"The path to the media folder where thumbnail images are stored.\nExample value: sitecore/media library/Project/sample-collection/sample-site","nullable":true,"example":"sitecore/media library/Project/sample-collection/sample-site"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the image to be used as the thumbnail."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: https://xmc-customer-tenant.sitecorecloud.io/-/media/Project/sample-collection/sample-site/System/7/0/B/C/thumbnail_70BC64BDE257400E82BFDB3344797DB7.png"},"children":[]}]}]}],"nullable":true,"example":"https://xmc-customer-tenant.sitecorecloud.io/-/media/Project/sample-collection/sample-site/System/7/0/B/C/thumbnail_70BC64BDE257400E82BFDB3344797DB7.png"}},"additionalProperties":false}},"components/schemas/ValidateCollectionNameInput":{"id":"components/schemas/ValidateCollectionNameInput","kind":"json-schema","title":"ValidateCollectionNameInput","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the site collection to validate.","nullable":true}},"additionalProperties":false}},"components/schemas/ValidateSiteNameInput":{"id":"components/schemas/ValidateSiteNameInput","kind":"json-schema","title":"ValidateSiteNameInput","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the site to validate.\nExample value: skate-park","nullable":true,"example":"skate-park"}},"additionalProperties":false,"description":"A site name validation request."}},"components/schemas/WorkflowStateStatistics":{"id":"components/schemas/WorkflowStateStatistics","kind":"json-schema","title":"WorkflowStateStatistics","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow state.\nExample value: Draft","nullable":true,"example":"Draft"},"pageCount":{"type":"integer","description":"The number of site pages that are currently in this workflow state.\nExample value: 60","format":"int32","example":60}},"additionalProperties":false,"description":"Represents the statistics for a workflow state."}},"components/schemas/WorkflowStatistics":{"id":"components/schemas/WorkflowStatistics","kind":"json-schema","title":"WorkflowStatistics","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow.\nExample value: Sample Workflow","nullable":true,"example":"Sample Workflow"},"states":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStateStatistics"},"description":"A collection of states defined for the workflow, and the number of pages in each state.","nullable":true}},"additionalProperties":false,"description":"Represents the workflow statistics."}},"components/schemas/WorkflowsStatistics":{"id":"components/schemas/WorkflowsStatistics","kind":"json-schema","title":"WorkflowsStatistics","data":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStatistics"},"description":"Collection of workflow statistics for the site.","nullable":true}},"additionalProperties":false,"description":"Represents the workflows statistics for a site."}},"schema_1363":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Job"}},"id":"schema_1363"},"schema_1364":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1364"},"schema_1365":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SiteCollection"}},"id":"schema_1365"},"schema_1366":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"id":"schema_1366"},"schema_1367":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SiteTemplate"}},"id":"schema_1367"},"schema_1368":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Language"}},"id":"schema_1368"},"schema_1369":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SupportedLanguage"}},"id":"schema_1369"},"schema_1370":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1370"},"schema_1371":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EditorProfileModel"}},"id":"schema_1371"},"schema_1372":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"}},"id":"schema_1372"},"schema_1373":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Host"}},"id":"schema_1373"},"schema_1374":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EditingHost"}},"id":"schema_1374"},"schema_1375":{"kind":"json-schema","data":{"required":["File"],"type":"object","properties":{"File":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image file to be used as a thumbnail. Should be sent as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Learn/Forms/Sending_and_retrieving_form_data#a_special_case_sending_files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"format":"binary"}}},"id":"schema_1375"},"schema_1376":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RenderingHost"}},"id":"schema_1376"}},"exampleStore":{"paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1jobs/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1jobs~1{jobHandle}~1status/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1{collectionId}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1{collectionId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1{collectionId}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1{collectionId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1{collectionId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1{collectionId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1{collectionId}~1rename/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1sort/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1sort/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1name~1validate/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1collections~1{collectionId}~1sites/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sites/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sites/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1favorites~1sites/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sitetemplates/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sitetemplates/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1favorites~1sitetemplates/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1favorites~1sites~1{siteId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1favorites~1sitetemplates~1{siteTemplateId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1languages/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1languages/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1languages~1supported/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1languages~1{isoCode}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1languages~1{isoCode}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1languages~1{isoCode}/delete/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1ui~1v1~1editorprofiles/get/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles/get/responses/401/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.3","title":"Forbidden","status":403,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles/get/responses/403/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1ui~1v1~1editorprofiles/post/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles/post/responses/401/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.3","title":"Forbidden","status":403,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles/post/responses/403/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/401/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.3","title":"Forbidden","status":403,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/403/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.3","title":"Forbidden","status":403,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/400/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.3","title":"Forbidden","status":403,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1ui~1v1~1editorprofiles~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1copy/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1rename/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1sort/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1sort/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1name~1validate/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1analytics-identifiers~1{analyticsIdentifier}~1detach/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1ancestors/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hierarchy~1{pageId}~1children/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.8","title":"Conflict","status":409,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts/post/responses/409/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.8","title":"Conflict","status":409,"traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/patch/responses/409/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1hosts~1{hostId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1editinghosts/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1templates/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1upload-thumbnail/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1statistics~1localization/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1configuration~1sitemap/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1statistics~1workflow/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1translate/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1sites~1{siteId}~1renderinghosts/get/responses/404/content/application~1json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}},"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/sai/sites-api/index.json?download"},{"url":"/_bundle/sai/sites-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Sites API","description":"Use the Sites API for managing sites, site collections and languages in the XM Apps system.\n\nThis API lets you interact with:\n- The Site Collection object. Use a site collection to group together related sites that share the same resources.\n- The Site object. The site object is the core entity that represents a website in the customer portfolio.\n- The Language object. The language object is used to manage the languages available to a tenant and site.\n- The Job object. The job object is used to manage running background jobs.\n\nNote the following:\n   - All API requests are made in your production environment.\n\n For more information, see the [official SitecoreAI developer documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/getting-started-with-xm-cloud.html).\n\n# Authorization\nTo authorize your requests, use environment automation client credentials and generate a JSON Web Token (JWT).\n\nNote: To create client credentials, you must be an [Organization Admin](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html) or Organization Owner.\n\n## Create an automation client\n 1. In the Sitecore Cloud Portal, open SitecoreAI Deploy.\n 2. Click **Credentials** > **Environment** > **Create credentials** > **Automation**.\n 3. Fill out the automation client details, then click **Create**.\n 4. Copy the client ID and the client secret because you won't be able to view them again in SitecoreAI Deploy. You'll use them to request a JWT.\n\n## Request a JWT\n\nRun the following cURL command to request a JWT. Replace the placeholder values with your client ID and client secret.\n```curl\n  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n```\n\nIn the response, the `access_token` key contains the JWT:\n\n```json\n  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n```\n\nThe JWT expires in 24 hours. If your requests unexpectedly return a response with status `401 Unauthorized`, request a new JWT by repeating this `POST` request.\n\nWe recommend that you cache the JWT for 24 hours to avoid repeating this `POST` request while the JWT is still valid.\n\n## Include the JWT in the request header\n\nYou can now start making REST API requests. You must include the JWT in the request header of every request. For example:\n  ```curl\n  curl -X GET '{YOUR_BASE_URL}/...' \\\n  -H 'Authorization: Bearer {YOUR_JWT}' \\\n  -H 'Accept: application/json'\n  ```","product":"SitecoreAI"}},"baseSlug":"/sai/sites-api","routesMapping":{}}