{"items":[{"type":"link","label":"Cache API","link":"/ch/cache-api","routeSlug":"/ch/cache-api","content":{"contentType":"overview","meta":{"name":"Cache API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/cache-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/cache-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"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://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Cache API (v1.0)","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 Cache API to clear your caches. A cache temporarily stores active data, such as web pages, text, and images, in a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dedicated local folder to accelerate access times and enhance overall performance. Content Hub uses various "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/cache.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"caches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you clear a cache, Content Hub rebuilds it using data from the database, which might result in a slight dip in performance for anyone using Content Hub at that time."},"children":[]}]}]}]}]}],"sectionId":"/ch/cache-api"}],"sectionId":"/ch/cache-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token and the client ID. Both are sent with every request. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one using the API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself"},"children":[]}]}]}]}]}]}]}],"sectionId":"/ch/cache-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/cache-api/section/authentication","routeSlug":"/ch/cache-api/section/authentication","content":null},{"type":"group","label":"Cache","link":"/ch/cache-api/cache","routeSlug":"/ch/cache-api/cache","items":[{"label":"Clear the cache","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/cache-api/cache/cache","routeSlug":"/ch/cache-api/cache/cache","metadata":{"seo":{"title":"Clear the cache","description":"Clears a specific cache using the cache name or clears all caches when the name is defined as all. We strongly recommend that you do not clear your caches during periods of high system load. This can temporarily degrade performance and increase response times for some users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Cache","name":"Clear the cache","isWebhook":false,"pointer":"/paths/~1api~1cache~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear the cache","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":"Clears a specific cache using the cache name or clears all caches when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is defined as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We strongly recommend that you do not clear your caches during periods of high system load. This can temporarily degrade performance and increase response times for some users."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_913","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the cache to clear. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear all caches."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1cache~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/cache/{name}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_913"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/cache/{name}","href":"cache/cache","openApiOperationId":"Cache","summary":"Clear the cache"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cache was successfully cleared"},{"code":"400","description":"The cache name was not provided or is invalid"},{"code":"401","description":"Unauthorized request. The user does not have permission to clear caches"},{"code":"404","description":"The specified cache name does not exist"}],"pointer":"/paths/~1api~1cache~1{name}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache/cache"}],"panels":[]}]},"httpPath":"/api/cache/{name}"}],"content":{"contentType":"group","meta":{"name":"Cache"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cache","showPageActions":true},{"nodeType":"markdoc","content":"Use the Cache API to clear the caches used by Content Hub."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/cache/{name}","summary":"Clear the cache","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cache/cache","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_913":{"kind":"json-schema","data":{"type":"string"},"id":"schema_913"}},"exampleStore":{},"securitySchemeStore":{"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-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/ch/cache-api/index.json?download"},{"url":"/_bundle/ch/cache-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Cache API","description":"Use the Cache API to clear your caches. A cache temporarily stores active data, such as web pages, text, and images, in a \ndedicated local folder to accelerate access times and enhance overall performance. Content Hub uses various [caches](https://doc.sitecore.com/ch/en/developers/cloud-dev/cache.html).\n\n{% admonition type=\"info\" name=\"Note\" %}When you clear a cache, Content Hub rebuilds it using data from the database, which might result in a slight dip in performance for anyone using Content Hub at that time.{% /admonition %}  \n## Authentication\n\nTo use this API, you need:\n\n- The URL of your Content Hub server. You can get this from your Content Hub\n  Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse \n  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n\n- An access token and the client ID. Both are sent with every request. You \n  can create a token through the [Content Hub\n  interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) \n  or by [requesting one using the API\n  itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows)\n","product":"Content Hub"}},"baseSlug":"/ch/cache-api","routesMapping":{}}