{"openapi":"3.0.3","info":{"title":"Fasterize API","description":"# Introduction\n[comment]: <> (x-product-description-placeholder)\nThe Fasterize API is built on HTTP and is RESTful.\nIt has predictable resource URLs and returns HTTP response codes to indicate errors.\nIt also accepts and returns JSON in the HTTP body.\nUse your favorite HTTP/REST library in your programming language when using this API.\n\nEvery action in the [Console](https://dashboard.fasterize.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.\nThis API reference documentation contains the most commonly integrated resources.\n\n# Authentication\n\nThis topic describes the different forms of authentication that are available in the API, and how to use them.\n\nFasterize offers two forms of authentication: secret key or JSON Web Tokens.\n\n- Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.\n- JWT: Use to make short-life tokens that expire after a set period of time.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n## Manage API keys\n\nTo create or manage API keys, select one of the following:\n\n- Use the Fasterize Console: go to the organization in the panel API.\n\n\n# Errors\nFasterize follows the error response format proposed in [RFC 9457](https://tools.ietf.org/html/rfc9457), which is also known as Problem Details for HTTP APIs. As with any API responses, your client must be prepared to gracefully handle additional members of the response.\n\n# Get started\n\nThe API is structured around our main products EdgeSpeed, EdgeSeo, EdgeGuard : \n* EdgeSpeed is our product for optimizing your web performance\n* EdgeSeo is our product for optimizing your SEO\n\nIf you would like to implement a particular use case,\n[contact Fasterize](https://www.fasterize.com/fr/page-de-contact/) for guidance and feedback on the best API operations to use for the task.\n","version":"2.0.0","contact":{"name":"Fasterize API Support","url":"https://support.fasterize.com/","email":"support@fasterize.com"},"termsOfService":"https://www.fasterize.com/fr/conditions-generales-de-vente/"},"components":{"securitySchemes":{"Secret API key":{"description":"For accessing the protected API resources, you must use a token available in each configuration defined in dashboard.fasterize.com, section API Key. This token must then be used for all protected resources by passing it in via the 'Authorization' header.\n\nRoute with sign is reserved to an user with admin access.","type":"apiKey","name":"Authorization","in":"header"},"JWT":{"type":"oauth2","description":"Auth0 use auth2","flows":{"authorizationCode":{"tokenUrl":"https://fasterize.eu.auth0.com/oauth/token","authorizationUrl":"https://fasterize.eu.auth0.com/authorize?audience=https://api.fasterize.com","scopes":{}}}}},"schemas":{"def-0":{"type":"object","properties":{"href_matches":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"selector_matches":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"and":{"type":"array","items":{"$ref":"#/components/schemas/def-0"}},"or":{"type":"array","items":{"$ref":"#/components/schemas/def-0"}},"not":{"$ref":"#/components/schemas/def-0"}},"additionalProperties":false,"title":"speculationRuleConditionSchema"}}},"paths":{"/v2/organizations/{id}":{"get":{"summary":"Get the details of an organization","tags":["Organizations"],"parameters":[{"schema":{"type":"boolean"},"in":"query","name":"withCSEandCSMValidation","required":false},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["organization:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the organization in the database","example":123,"type":"number"},"name":{"description":"Name of the organization","example":"Organization A","type":"string"},"description":{"description":"Description of the organization","example":"Our organization does x and y","type":"string"},"createdAt":{"description":"Creation date of the organization in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the organization in the database","type":"string","format":"date-time","example":{}},"cseId":{"description":"CSE user id of the organization in the database","type":"number","nullable":true,"example":1},"csmId":{"description":"CSM user id of the organization in the database","type":"number","nullable":true,"example":1},"partnerId":{"description":"The id of the partner which manages this organization","type":"number","nullable":true,"example":1},"displayWpRanking":{"description":"If true then the organization will display the wp ranking","type":"boolean","example":true},"cse":{"type":"object","nullable":true,"properties":{"email":{"description":"The email of the invited user","type":"string","example":"example@email.com"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"Picture of the user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"avatar.png"}}},"csm":{"type":"object","nullable":true,"properties":{"email":{"description":"The email of the invited user","type":"string","example":"example@email.com"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"Picture of the user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"avatar.png"}}},"projects":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the project in the database","example":123,"type":"number"},"name":{"description":"Name of the project","example":"Project A","type":"string"},"description":{"description":"Description of the project","example":"Our project does x and y","type":"string"},"organizationId":{"description":"Id of the organization to which the project belongs","example":123,"type":"number"},"createdAt":{"description":"Creation date of the project in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the project in the database","type":"string","format":"date-time","example":{}},"activatedProducts":{"description":"Activated products","type":"array","example":[{"slug":"seo","id":1}]},"websites":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}}}}},"subscribedProducts":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"websiteCount":{"description":"Number of websites in the organization (only present when requested with withWebsiteCount)","type":"number","example":3}}}}}}}}},"/v2/organizations/{id}/members":{"get":{"summary":"List members of an organization","tags":["Organization Members"],"parameters":[{"schema":{"type":"string","format":"email"},"example":"paul.martin@walmart.com","in":"query","name":"email","required":false,"description":"Member's email"},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["organization:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}}}}},"/v2/organizations/{id}/members/{user_id}":{"get":{"summary":"Get a member of an organization","tags":["Organization Members"],"parameters":[{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"user_id","required":true,"description":"Member ID"}],"security":[{"Secret API key":[],"JWT":["organization:read"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}}},"put":{"summary":"Update a member of an organization","tags":["Organization Members"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"description":"The id of the role of the member","type":"number","example":123},"roleName":{"description":"The name of the role of the member","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Administrator"},"email":{"description":"The email of the invited user","type":"string","format":"email","example":"example@email.com"},"givenName":{"description":"The given name of the invited user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"John"},"familyName":{"description":"The family name of the invited user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Doe"},"picture":{"description":"Picture of the user","type":"string","example":"avatar.png"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"user_id","required":true,"description":"Member ID"}],"security":[{"Secret API key":[],"JWT":["organization:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}},"delete":{"summary":"Remove a member from an organization","tags":["Organization Members"],"parameters":[{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"user_id","required":true,"description":"Member ID"}],"security":[{"Secret API key":[],"JWT":["organization:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/organizations/{id}/members/invite":{"post":{"summary":"Invite a member to an organization","tags":["Organization Members"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["roleName","senderEmail","email","givenName","familyName"],"properties":{"roleName":{"description":"The name of the role","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Administrator"},"senderEmail":{"description":"The email of the sender","type":"string","format":"email","example":"example@email.com"},"email":{"description":"The email of the invited user","type":"string","format":"email","example":"example@email.com"},"givenName":{"description":"The given name of the invited user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"John"},"familyName":{"description":"The family name of the invited user","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Doe"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","enum":["en","fr"]},"in":"query","name":"lang","required":false},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["user:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/organizations/{id}/members/reinvite":{"post":{"summary":"Resend invitation for a member","tags":["Organization Members"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"senderEmail":{"description":"The email of the sender","type":"string","format":"email","example":"example@email.com"},"email":{"description":"The email of the invited user","type":"string","format":"email","example":"example@email.com"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","enum":["en","fr"]},"in":"query","name":"lang","required":false},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["user:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/organizations/{id}/projects":{"get":{"summary":"List projects of an organization","tags":["Organizations"],"parameters":[{"schema":{"type":"string","enum":["edge_speed","edge_seo","edge_watch"]},"in":"query","name":"product","required":false},{"schema":{"type":"boolean"},"in":"query","name":"withWebsites","required":false},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["organization:read","project:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the project in the database","example":123,"type":"number"},"name":{"description":"Name of the project","example":"Project A","type":"string"},"description":{"description":"Description of the project","example":"Our project does x and y","type":"string"},"organizationId":{"description":"Id of the organization to which the project belongs","example":123,"type":"number"},"createdAt":{"description":"Creation date of the project in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the project in the database","type":"string","format":"date-time","example":{}},"activatedProducts":{"description":"Activated products","type":"array","example":[{"slug":"seo","id":1}]},"websites":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}}}}}}}}}}},"/v2/organizations/{id}/websites":{"get":{"summary":"List websites of an organization","tags":["Organizations"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"my.website.com","in":"query","name":"domain","required":false,"description":"Website domain"},{"schema":{"type":"string","enum":["production","staging","development"]},"example":"production","in":"query","name":"environment","required":false,"description":"Website related environment"},{"schema":{"type":"boolean"},"in":"query","name":"isPlugged","required":false,"description":"Status of the website"},{"schema":{"type":"string"},"in":"query","name":"configId","required":false},{"schema":{"type":"string"},"in":"query","name":"cseId","required":false},{"schema":{"type":"string"},"in":"query","name":"csmId","required":false},{"schema":{"type":"number"},"in":"query","name":"partnerId","required":false},{"schema":{"type":"number"},"in":"query","name":"projectId","required":false},{"schema":{"type":"number"},"in":"query","name":"organizationId","required":false},{"schema":{"type":"string"},"in":"query","name":"configType","required":false},{"schema":{"type":"string"},"in":"query","name":"region","required":false},{"schema":{"type":"number","minimum":0},"example":1,"in":"query","name":"_start","required":false,"description":"Position of the first data"},{"schema":{"type":"number"},"example":5,"in":"query","name":"_end","required":false,"description":"Position of the last data"},{"schema":{"type":"string","enum":["ASC","DESC"]},"example":"ASC","in":"query","name":"_order","required":false,"description":"Order of data"},{"schema":{"type":"string"},"example":"id","in":"query","name":"_sort","required":false,"description":"Property used for the sorting"},{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"Full-text search on the name field"},{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":["organization:read","project:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}}}}}}}},"/v2/users/{id}":{"put":{"summary":"Update profile information","tags":["Profile"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"givenName":{"type":"string","description":"Given Name","pattern":"^[^<>\"{}]{1,200}$","example":"John"},"familyName":{"type":"string","description":"Family Name","pattern":"^[^<>\"{}]{1,200}$","example":"Smith"},"picture":{"type":"string","description":"picture","minLength":1,"example":"https://www.url.to.picture.com/the/picture.jpg"},"phoneNumber":{"type":"string","description":"Phone Number","example":"0643671356"},"profession":{"type":"string","description":"Profession","pattern":"^[^<>\"{}]{1,200}$","example":"Sales"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"User ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}}}},"/v2/admin/users/{id}":{"put":{"summary":"Update privileged user information","tags":["Profile"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"givenName":{"type":"string","description":"Given Name","pattern":"^[^<>\"{}]{1,200}$","example":"John"},"familyName":{"type":"string","description":"Family Name","pattern":"^[^<>\"{}]{1,200}$","example":"Smith"},"picture":{"type":"string","description":"picture","minLength":1,"example":"https://www.url.to.picture.com/the/picture.jpg"},"phoneNumber":{"type":"string","description":"Phone Number","example":"0643671356"},"profession":{"type":"string","description":"Profession","pattern":"^[^<>\"{}]{1,200}$","example":"Sales"},"roleName":{"type":"string","description":"The privileged role for the user","enum":["admin","partner"]},"partnerId":{"description":"The partner group this user is tied to","type":"number","example":123}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"User ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}}}},"/v2/projects/{id}":{"get":{"summary":"Get project details","tags":["Organizations"],"parameters":[{"schema":{"type":"boolean"},"in":"query","name":"with_websites","required":false,"description":"Include websites in the response"},{"schema":{"type":"string","enum":["edge_speed","edge_seo","edge_watch"]},"in":"query","name":"product","required":false,"description":"Filter websites by product (edge_speed or edge_seo), only applied when `with_websites` is true. edge_watch is accepted but treated as no filter."},{"schema":{"type":"integer"},"examples":{"1":{"value":1},"2":{"value":2},"3":{"value":3}},"in":"path","name":"id","required":true,"description":"Project ID"},{"schema":{"type":"string","pattern":"^[^<>\"{}]{1,200}$"},"example":"Project A","in":"path","name":"name","required":true,"description":"The name of the project"}],"security":[{"Secret API key":[],"JWT":["project:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the project in the database","example":123,"type":"number"},"name":{"description":"Name of the project","example":"Project A","type":"string"},"description":{"description":"Description of the project","example":"Our project does x and y","type":"string"},"organizationId":{"description":"Id of the organization to which the project belongs","example":123,"type":"number"},"createdAt":{"description":"Creation date of the project in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the project in the database","type":"string","format":"date-time","example":{}},"activatedProducts":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"websites":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}},"organization":{"type":"object","properties":{"id":{"description":"Id of the organization in the database","example":123,"type":"number"},"name":{"description":"Name of the organization","example":"Organization A","type":"string"},"description":{"description":"Description of the organization","example":"Our organization does x and y","type":"string"},"createdAt":{"description":"Creation date of the organization in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the organization in the database","type":"string","format":"date-time","example":{}},"cseId":{"description":"CSE user id of the organization in the database","type":"number","nullable":true,"example":1},"csmId":{"description":"CSM user id of the organization in the database","type":"number","nullable":true,"example":1},"partnerId":{"description":"The id of the partner which manages this organization","type":"number","nullable":true,"example":1},"displayWpRanking":{"description":"If true then the organization will display the wp ranking","type":"boolean","example":true},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}},"nullable":true},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}},"nullable":true}}},"availableProducts":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}}}}}}}}},"put":{"summary":"Update a project","tags":["Organizations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the project","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Project A"},"description":{"description":"A description of the project","type":"string","example":"This project concerns x, does y"},"organizationId":{"description":"The id of the organization","type":"integer","example":1},"activatedProductIds":{"description":"Activated products Ids","type":"array","example":[1]}}}}}},"parameters":[{"schema":{"type":"integer"},"examples":{"1":{"value":1},"2":{"value":2},"3":{"value":3}},"in":"path","name":"id","required":true,"description":"Project ID"},{"schema":{"type":"string","pattern":"^[^<>\"{}]{1,200}$"},"example":"Project A","in":"path","name":"name","required":true,"description":"The name of the project"}],"security":[{"Secret API key":[],"JWT":["project:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the project in the database","example":123,"type":"number"},"name":{"description":"Name of the project","example":"Project A","type":"string"},"description":{"description":"Description of the project","example":"Our project does x and y","type":"string"},"organizationId":{"description":"Id of the organization to which the project belongs","example":123,"type":"number"},"createdAt":{"description":"Creation date of the project in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the project in the database","type":"string","format":"date-time","example":{}},"activatedProducts":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"websites":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}},"organization":{"type":"object","properties":{"id":{"description":"Id of the organization in the database","example":123,"type":"number"},"name":{"description":"Name of the organization","example":"Organization A","type":"string"},"description":{"description":"Description of the organization","example":"Our organization does x and y","type":"string"},"createdAt":{"description":"Creation date of the organization in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the organization in the database","type":"string","format":"date-time","example":{}},"cseId":{"description":"CSE user id of the organization in the database","type":"number","nullable":true,"example":1},"csmId":{"description":"CSM user id of the organization in the database","type":"number","nullable":true,"example":1},"partnerId":{"description":"The id of the partner which manages this organization","type":"number","nullable":true,"example":1},"displayWpRanking":{"description":"If true then the organization will display the wp ranking","type":"boolean","example":true},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}},"nullable":true},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}},"nullable":true}}},"availableProducts":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}}}}}}}}}},"/v2/websites/{id}":{"get":{"summary":"Get website details","tags":["Websites"],"parameters":[{"schema":{"type":"number"},"example":1234,"in":"path","name":"id","required":true,"description":"Website ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the website in the database","example":123,"type":"number"},"domain":{"description":"Domain and name of the website","example":"www.website.com","type":"string"},"virtualHost":{"description":"Override the domain for fronts services.","example":"www-website-com.fzcdn.net","type":"string"},"description":{"description":"Description of the website","example":"Our website does x and y","type":"string"},"environment":{"description":"Environment of the website","type":"string","example":"production"},"projectId":{"description":"Id of the project of the website","example":123,"type":"number"},"configId":{"description":"Id of the config of the website","example":"123","type":"string"},"isPlugged":{"description":"Status of the website","example":true,"type":"boolean"},"analysesEnabled":{"description":"Whether the scheduled analyses run for this website, whatever its CDN logs collection","example":true,"type":"boolean"},"createdAt":{"description":"Creation date of the website in the database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of the website in the database","type":"string","format":"date-time","example":{}},"configTypeIds":{"description":"Config type Ids","type":"array","example":[1]},"region":{"description":"Region where the website is optimized","type":"string","example":"euwest1"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}}},"configTypes":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"description":"Id of the product in the database","example":123,"type":"number"},"slug":{"description":"Slug of the product","example":"edge_speed","type":"string"}}},"isOptimized":{"type":"boolean"}}}},"project":{"type":"object","properties":{"name":{"type":"string","description":"Project name"},"id":{"type":"number","description":"Project id"},"organization":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"number"},"cse":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}},"csm":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}},"wpDomainId":{"description":"ID of the matching WpDomain if exists, null if it doesn't exist, or undefined if not loaded","type":"number","nullable":true,"example":1}}}}}}}}},"/v2/configs/{id}/targets":{"get":{"summary":"Get configuration targets","tags":["Target"],"parameters":[{"schema":{"type":"number","minimum":0},"example":1,"in":"query","name":"_start","required":false,"description":"Position of the first data"},{"schema":{"type":"number"},"example":5,"in":"query","name":"_end","required":false,"description":"Position of the last data"},{"schema":{"type":"string","enum":["ASC","DESC"]},"example":"ASC","in":"query","name":"_order","required":false,"description":"Order of data"},{"schema":{"type":"string"},"example":"id","in":"query","name":"_sort","required":false,"description":"Property used for the sorting"},{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"Full-text search on the name field"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["target:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["label","context","id","excluded"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"Whether the target is excluded"},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"id":{"type":"string","title":"Target ID"}}}}}}}}},"post":{"summary":"Add a target","tags":["Target"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"exclude (don't optimize) this target if set to true","default":false},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["target:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context","id","excluded"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"Whether the target is excluded"},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"id":{"type":"string","title":"Target ID"}}}}}}}}},"/v2/configs/{id}/targets/{target_id}":{"get":{"summary":"Get a target","tags":["Target"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"home_page","in":"path","name":"target_id","required":true,"description":"Target ID"}],"security":[{"Secret API key":[],"JWT":["target:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context","id","excluded"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"Whether the target is excluded"},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"id":{"type":"string","title":"Target ID"}}}}}}}},"delete":{"summary":"Delete a target","tags":["Target"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"home_page","in":"path","name":"target_id","required":true,"description":"Target ID"}],"security":[{"Secret API key":[],"JWT":["target:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"409":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"put":{"summary":"Update a target","tags":["Target"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"exclude (don't optimize) this target if set to true","default":false},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"home_page","in":"path","name":"target_id","required":true,"description":"Target ID"}],"security":[{"Secret API key":[],"JWT":["target:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context","id","excluded"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"Whether the target is excluded"},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"id":{"type":"string","title":"Target ID"}}}}}}}}},"/v2/configs/{id}/targets/{target_id}/duplicate":{"post":{"summary":"Clone a target","tags":["Target"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"Target label","minLength":1,"example":"Homepage"},"description":{"type":"string","description":"Target description","example":"Target for the homepage."},"keep_apps_settings":{"type":"boolean","description":"If applications parameters should be kept during target's duplication","example":true}},"required":["label","keep_apps_settings"]}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"home_page","in":"path","name":"target_id","required":true,"description":"Target ID"}],"security":[{"Secret API key":[],"JWT":["target:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["label","context","id","excluded"],"properties":{"label":{"type":"string","title":"target label"},"description":{"type":"string","title":"description detailing the target"},"enabled":{"type":"boolean","title":"don't consider this target (set in pause) if set to false","default":true},"excluded":{"type":"boolean","title":"Whether the target is excluded"},"pageType":{"type":"string","pattern":"^[a-z][a-z0-9_-]*$","title":"the page type defined by this target"},"witnessUrls":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uri","pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[^/?#\\s@]+"},"title":"1 to 3 representative URLs of the page type this target defines, captured first by sampled analyses"},"context":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"tag_url":{"oneOf":[{"type":"object","title":"The Tag URL is an URL found in a tag. It is the src or srcset attributes for img tag ; href attribute for link tag ; src attribute for script tag. URL in CSS properties are also captured","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"css_selector":{"title":"CSS selector","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"id":{"type":"string","title":"Target ID"}}}}}}}}},"/v2/configs/{id}/operations":{"get":{"summary":"List activity events for a website configuration","tags":["Activity Events"],"parameters":[{"schema":{"type":"string"},"example":"10","in":"query","name":"configId","required":false,"description":"Searched configId."},{"schema":{"type":"string"},"example":"FLUSH_CACHE","in":"query","name":"type","required":false,"description":"Searched type."},{"schema":{"type":"string"},"example":"FLUSH_CACHE,UPDATE","in":"query","name":"types","required":false,"description":"Comma seperated list of types to search for."},{"schema":{"type":"string"},"example":"sitemap","in":"query","name":"applicationIds","required":false,"description":"Searched applicationId."},{"schema":{"type":"string"},"example":"CONFIG","in":"query","name":"subject","required":false,"description":"Searched subject."},{"schema":{"type":"string"},"example":"CONFIG,APPLICATION","in":"query","name":"subjects","required":false,"description":"Comma seperated list of subjects to search for."},{"schema":{"type":"string"},"example":"PENDING","in":"query","name":"status","required":false,"description":"Searched status."},{"schema":{"type":"string"},"example":"Started with www.example.com","in":"query","name":"description","required":false,"description":"Searched description (like)."},{"schema":{"type":"string"},"examples":{"2025-01-01":{"value":"2025-01-01"},"2025-01-01,2025-01-02":{"value":"2025-01-01,2025-01-02"}},"in":"query","name":"period","required":false,"description":"Searched period."},{"schema":{"type":"string"},"example":"10,11","in":"query","name":"userIds","required":false,"description":"Comma seperated list of user ids to search for."},{"schema":{"type":"number","minimum":0},"example":1,"in":"query","name":"_start","required":false,"description":"Position of the first data"},{"schema":{"type":"number"},"example":5,"in":"query","name":"_end","required":false,"description":"Position of the last data"},{"schema":{"type":"string","enum":["ASC","DESC"]},"example":"ASC","in":"query","name":"_order","required":false,"description":"Order of data"},{"schema":{"type":"string"},"example":"id","in":"query","name":"_sort","required":false,"description":"Property used for the sorting"},{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"Full-text search on the name field"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}},"/v2/operations/{id}/operations_information":{"get":{"summary":"Get details of an activity event","tags":["Activity Events"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Operation ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"operationId":{"description":"Operation id of the operation","type":"number","example":10},"code":{"description":"Code of the msg for i18n","type":"string","example":"OPERATION_DEPLOY_CDN_CERT_SUCCESS"},"message":{"description":"Human readable log","type":"string","example":"Certificate deployed on the cdn"},"status":{"description":"Status of the current operation information","type":"string","example":"error"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}}}}}}}}},"/v2/operations/{id}":{"get":{"summary":"Get an activity event","tags":["Activity Events"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Operation ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/users/operations":{"get":{"summary":"List users who have performed operations","tags":["Activity Events","Users"],"parameters":[{"schema":{"type":"string"},"example":"10","in":"query","name":"configId","required":false,"description":"Searched configId."},{"schema":{"type":"string"},"example":"FLUSH_CACHE","in":"query","name":"type","required":false,"description":"Searched type."},{"schema":{"type":"string"},"example":"FLUSH_CACHE,UPDATE","in":"query","name":"types","required":false,"description":"Comma seperated list of types to search for."},{"schema":{"type":"string"},"example":"sitemap","in":"query","name":"applicationIds","required":false,"description":"Searched applicationId."},{"schema":{"type":"string"},"example":"CONFIG","in":"query","name":"subject","required":false,"description":"Searched subject."},{"schema":{"type":"string"},"example":"CONFIG,APPLICATION","in":"query","name":"subjects","required":false,"description":"Comma seperated list of subjects to search for."},{"schema":{"type":"string"},"example":"PENDING","in":"query","name":"status","required":false,"description":"Searched status."},{"schema":{"type":"string"},"example":"Started with www.example.com","in":"query","name":"description","required":false,"description":"Searched description (like)."},{"schema":{"type":"string"},"examples":{"2025-01-01":{"value":"2025-01-01"},"2025-01-01,2025-01-02":{"value":"2025-01-01,2025-01-02"}},"in":"query","name":"period","required":false,"description":"Searched period."},{"schema":{"type":"string"},"example":"10,11","in":"query","name":"userIds","required":false,"description":"Comma seperated list of user ids to search for."},{"schema":{"type":"number","minimum":0},"example":1,"in":"query","name":"_start","required":false,"description":"Position of the first data"},{"schema":{"type":"number"},"example":5,"in":"query","name":"_end","required":false,"description":"Position of the last data"},{"schema":{"type":"string","enum":["ASC","DESC"]},"example":"ASC","in":"query","name":"_order","required":false,"description":"Order of data"},{"schema":{"type":"string"},"example":"id","in":"query","name":"_sort","required":false,"description":"Property used for the sorting"},{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"Full-text search on the name field"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the member in the database","example":123,"type":"number"},"email":{"description":"The email name of the member","example":"example@email.com","type":"string"},"givenName":{"description":"The given name of the member","example":"givenName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"familyName":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"picture":{"description":"A link to a picture of the member","example":"example.com/link-to-the-picture","type":"string"},"roleName":{"description":"The name of the role of the member","example":"Administrator","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"phoneNumber":{"description":"The phone number of the member","example":"familyName A","type":"string"},"profession":{"description":"The family name of the member","example":"familyName A","type":"string","pattern":"^[^<>\"{}]{1,200}$"},"partnerId":{"description":"The partnerId of the user","example":1,"type":"number"},"last_login":{"description":"The last login of the member","type":"string","format":"date-time","example":{}},"isAdmin":{"description":"If true then the user is an admin","type":"boolean","example":true},"slackId":{"description":"The slack id of the member","example":"U1234567890","type":"string"}}}}}}}}}},"/v2/organizations/{organizationId}/tls_certificates":{"get":{"summary":"List certificates for an organization","tags":["TLS Certificates","Organizations"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"q","required":false,"description":"Full-text search on the name field"},{"schema":{"type":"string","minLength":1},"example":"*.domain.com","in":"query","name":"domain","required":false,"description":"Searched domain."},{"schema":{"type":"string"},"in":"query","name":"certificate","required":false,"description":"Searched certificate name."},{"schema":{"type":"number"},"examples":{"10":{"value":10},"11":{"value":11},"12":{"value":12}},"in":"query","name":"organization_id","required":false,"description":"Filter for organization"},{"schema":{"type":"string","format":"date-time"},"example":"2019-04-24T18:19:13.433Z","in":"query","name":"notAfter","required":false,"description":"Filter out certificates whose expiry date is before this date"},{"schema":{"type":"number","minimum":0},"example":1,"in":"query","name":"_start","required":false,"description":"Position of the first data"},{"schema":{"type":"number"},"example":5,"in":"query","name":"_end","required":false,"description":"Position of the last data"},{"schema":{"type":"string","enum":["ASC","DESC"]},"example":"ASC","in":"query","name":"_order","required":false,"description":"Order of data"},{"schema":{"type":"string"},"example":"id","in":"query","name":"_sort","required":false,"description":"Property used for the sorting"},{"schema":{"type":"integer"},"examples":{"1":{"value":1},"2":{"value":2},"3":{"value":3}},"in":"path","name":"organizationId","required":true,"description":"The id of the organization"}],"security":[{"Secret API key":[],"JWT":["certificate:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the certificate in vault / database","type":"string","example":"example_com_1XABCD"},"subject":{"description":"Target domain","type":"string","example":"example.com"},"serial":{"description":"Unique Serial of the certificate","type":"string","example":"1XABCD"},"issuer":{"description":"Issuer of the certicate","type":"string","example":"Let's Encrypt Authority X3"},"issuerSerial":{"description":"Issuer Serial of the certicate","type":"string","example":"A84A6A63047DDD"},"sans":{"description":"Domain & subdomain where the certificate is valid","type":"array","items":{"type":"string"},"example":["example.com","*.example.com","great.example.com"]},"notBefore":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"notAfter":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"extendedValidation":{"description":"extended_validation is true when the certificate has an extended validation issued","type":"boolean","example":false},"managed":{"description":"Managed is true when the certificate is generated via letsencrypt by fasterize","type":"boolean","example":false},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}}}}}}}}},"/v2/configs/{id}/certificate":{"get":{"summary":"Get status of certificate deployment for website config","tags":["TLS Certificates"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read","certificate:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"cloudfrontCertificate":{"type":"object","properties":{"id":{"description":"Id of the certificate in vault / database","type":"string","example":"example_com_1XABCD"},"subject":{"description":"Target domain","type":"string","example":"example.com"},"serial":{"description":"Unique Serial of the certificate","type":"string","example":"1XABCD"},"issuer":{"description":"Issuer of the certicate","type":"string","example":"Let's Encrypt Authority X3"},"issuerSerial":{"description":"Issuer Serial of the certicate","type":"string","example":"A84A6A63047DDD"},"sans":{"description":"Domain & subdomain where the certificate is valid","type":"array","items":{"type":"string"},"example":["example.com","*.example.com","great.example.com"]},"notBefore":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"notAfter":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"extendedValidation":{"description":"extended_validation is true when the certificate has an extended validation issued","type":"boolean","example":false},"managed":{"description":"Managed is true when the certificate is generated via letsencrypt by fasterize","type":"boolean","example":false},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}},"vhostCertificate":{"type":"object","properties":{"id":{"description":"Id of the certificate in vault / database","type":"string","example":"example_com_1XABCD"},"subject":{"description":"Target domain","type":"string","example":"example.com"},"serial":{"description":"Unique Serial of the certificate","type":"string","example":"1XABCD"},"issuer":{"description":"Issuer of the certicate","type":"string","example":"Let's Encrypt Authority X3"},"issuerSerial":{"description":"Issuer Serial of the certicate","type":"string","example":"A84A6A63047DDD"},"sans":{"description":"Domain & subdomain where the certificate is valid","type":"array","items":{"type":"string"},"example":["example.com","*.example.com","great.example.com"]},"notBefore":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"notAfter":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"extendedValidation":{"description":"extended_validation is true when the certificate has an extended validation issued","type":"boolean","example":false},"managed":{"description":"Managed is true when the certificate is generated via letsencrypt by fasterize","type":"boolean","example":false},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}},"configCertificate":{"type":"object","properties":{"id":{"description":"Id of the certificate in vault / database","type":"string","example":"example_com_1XABCD"},"subject":{"description":"Target domain","type":"string","example":"example.com"},"serial":{"description":"Unique Serial of the certificate","type":"string","example":"1XABCD"},"issuer":{"description":"Issuer of the certicate","type":"string","example":"Let's Encrypt Authority X3"},"issuerSerial":{"description":"Issuer Serial of the certicate","type":"string","example":"A84A6A63047DDD"},"sans":{"description":"Domain & subdomain where the certificate is valid","type":"array","items":{"type":"string"},"example":["example.com","*.example.com","great.example.com"]},"notBefore":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"notAfter":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"extendedValidation":{"description":"extended_validation is true when the certificate has an extended validation issued","type":"boolean","example":false},"managed":{"description":"Managed is true when the certificate is generated via letsencrypt by fasterize","type":"boolean","example":false},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}}}}}}}}}},"/v2/configs/{id}/status/plugged":{"get":{"summary":"Website plugging status","tags":["Website Status"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domain","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read","plug:read"]}],"responses":{}}},"/v2/configs/{id}/status/plug":{"post":{"summary":"Plug a website to Fasterize","tags":["Website Status"],"parameters":[{"schema":{"type":"string","minLength":1,"anyOf":[{"type":"string","format":"hostname"},{"type":"string","format":"wildcard_domain"}]},"example":"www.domain.com","in":"query","name":"domain","required":true,"description":"Domain from the configuration"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:write","plug:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/status/unplug":{"post":{"summary":"Unplug a website to Fasterize","tags":["Website Status"],"parameters":[{"schema":{"type":"string","minLength":1,"anyOf":[{"type":"string","format":"hostname"},{"type":"string","format":"wildcard_domain"}]},"example":"www.domain.com","in":"query","name":"domain","required":true,"description":"Domain from the configuration"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:write","plug:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/status":{"post":{"summary":"Update optimization status","tags":["Website Status"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"products":{"type":"array","description":"Name of product","items":{"type":"string","enum":["edge_seo","edge_speed","edge_watch"]}},"status":{"type":"boolean","description":"Status of optimization","default":true},"supportTicket":{"type":"string","description":"Ticket ID"},"description":{"type":"string","description":"Description of the config update"}},"required":["products","status"]}}}},"parameters":[{"schema":{"type":"string","minLength":1,"anyOf":[{"type":"string","format":"hostname"},{"type":"string","format":"wildcard_domain"}]},"example":"www.domain.com","in":"query","name":"domain","required":true,"description":"Domain from the configuration"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["optimization:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}},"get":{"summary":"Get website status","tags":["Website Status"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"domain","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read","plug:read","optimization:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"plugged":{"type":"boolean"},"pluggedFromConfig":{"type":"boolean"},"optimized":{"type":"object","properties":{"edge_speed":{"type":"boolean"},"edge_seo":{"type":"boolean"}},"required":["edge_speed","edge_seo"]},"fallbackOrigin":{"type":"boolean"},"inProgressPlugOperation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}},"inProgressOptimizationOperation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}},"pingBlocked":{"type":"boolean"},"protectedByWAF":{"type":"boolean"},"shield_active":{"type":"boolean"},"shield_primary":{"type":"object","description":"For a Cloudflare secondary config, the Shield-active config that owns the shared zone.","properties":{"config_id":{"type":"string"},"domain":{"type":"string"}},"nullable":true}}}}}}}}},"/v2/website/{id}/certificate/expiration":{"get":{"summary":"Get expiration date of certificate associated to the website","tags":["TLS Certificates"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Website ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/tls_certificates/upload":{"post":{"summary":"Upload a new SSL certificate and its private key in PEM Format.\n        Once it is uploaded apply it to the associated websites and return the operation results","tags":["TLS Certificates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["certificate","private_key"],"properties":{"certificate":{"description":"SSL certificate in PEM format","type":"string","example":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"},"private_key":{"description":"Private key in PEM format without passphrase","type":"string","example":"-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"},"managed":{"description":"Set managed to true when the certificate is generated via letsencrypt by fasterize","type":"boolean","default":false,"example":false},"force_flavor":{"description":"Set force_flavor to true when you want to force the flavor (cfssl) of the certificate to get all chain","type":"boolean","default":false,"example":false},"organization_id":{"description":"Id of the organization the certificate belongs to","type":"number","example":1}}}}}},"security":[{"Secret API key":[],"JWT":["certificate:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"description":"Id of the certificate in vault / database","type":"string","example":"example_com_1XABCD"},"subject":{"description":"Target domain","type":"string","example":"example.com"},"serial":{"description":"Unique Serial of the certificate","type":"string","example":"1XABCD"},"issuer":{"description":"Issuer of the certicate","type":"string","example":"Let's Encrypt Authority X3"},"issuerSerial":{"description":"Issuer Serial of the certicate","type":"string","example":"A84A6A63047DDD"},"sans":{"description":"Domain & subdomain where the certificate is valid","type":"array","items":{"type":"string"},"example":["example.com","*.example.com","great.example.com"]},"notBefore":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"notAfter":{"description":"Certificate expiration time","type":"string","format":"date-time","example":{}},"extendedValidation":{"description":"extended_validation is true when the certificate has an extended validation issued","type":"boolean","example":false},"managed":{"description":"Managed is true when the certificate is generated via letsencrypt by fasterize","type":"boolean","example":false},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}}}},"operations":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}}},"/v2/configs/{id}/cdn/cloudflare/prepare":{"post":{"summary":"Prepare Cloudflare CDN configuration before setup","tags":["Cloudflare"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/cdn/cloudflare/setup":{"put":{"summary":"Create and setup Cloudflare zone - idempotent operation that handles setup","tags":["Cloudflare"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/cloudflare/apply":{"post":{"summary":"Re-apply named Cloudflare configure steps on an already managed zone","tags":["Cloudflare"],"description":"Replays the Cloudflare configure pipeline restricted to the steps named in `steps`. Takes no request body: it reads the stored configuration and never writes one back. CONFIGURE_LOGPUSH is opt-in and only runs when named explicitly.","parameters":[{"schema":{"type":"string","pattern":"^(CREATE_ZONE|ENTERPRISE_PLAN_SUBSCRIPTION|UPDATE_AS_PARTIAL_ZONE|CREATE_ROUTE53_VERIFICATION_RECORD|CREATE_FALLBACK_CNAME|CREATE_CLOUDFLARE_SERVICE_CNAME|CREATE_ROUTE53_SERVICE_CNAME|CONFIGURE_FALLBACK_ORIGIN|CREATE_CUSTOM_HOSTNAME|CONFIGURE_LOGPUSH|CREATE_PLATFORM_ORIGIN_CNAME|CREATE_ORIGIN_CNAME|SAVE_ZONE_VERIFICATION_CHALLENGE|CONFIGURE_ZONE_SETTINGS|CONFIGURE_COMPRESSION_RULESET|CONFIGURE_WAF|CONFIGURE_CACHE|CONFIGURE_TIERED_CACHE|CONFIGURE_SERVER_TIMING_HEADER|CONFIGURE_PAGE_WORKER|CREATE_WORKER_ROUTES|CONFIGURE_VISITOR_ASN|CONFIGURE_AVIF_SNIPPET|UPLOAD_AVIF_SNIPPET|CONFIGURE_CUSTOM_HOSTNAME_CERT|CONFIGURE_EDGE_CERTIFICATE|DISABLE_ZONE_HOLD|CONFIGURE_GCP_ORIGIN_RULE)(,(CREATE_ZONE|ENTERPRISE_PLAN_SUBSCRIPTION|UPDATE_AS_PARTIAL_ZONE|CREATE_ROUTE53_VERIFICATION_RECORD|CREATE_FALLBACK_CNAME|CREATE_CLOUDFLARE_SERVICE_CNAME|CREATE_ROUTE53_SERVICE_CNAME|CONFIGURE_FALLBACK_ORIGIN|CREATE_CUSTOM_HOSTNAME|CONFIGURE_LOGPUSH|CREATE_PLATFORM_ORIGIN_CNAME|CREATE_ORIGIN_CNAME|SAVE_ZONE_VERIFICATION_CHALLENGE|CONFIGURE_ZONE_SETTINGS|CONFIGURE_COMPRESSION_RULESET|CONFIGURE_WAF|CONFIGURE_CACHE|CONFIGURE_TIERED_CACHE|CONFIGURE_SERVER_TIMING_HEADER|CONFIGURE_PAGE_WORKER|CREATE_WORKER_ROUTES|CONFIGURE_VISITOR_ASN|CONFIGURE_AVIF_SNIPPET|UPLOAD_AVIF_SNIPPET|CONFIGURE_CUSTOM_HOSTNAME_CERT|CONFIGURE_EDGE_CERTIFICATE|DISABLE_ZONE_HOLD|CONFIGURE_GCP_ORIGIN_RULE))*$"},"examples":{"CONFIGURE_LOGPUSH":{"value":"CONFIGURE_LOGPUSH"},"CONFIGURE_LOGPUSH,CONFIGURE_PAGE_WORKER":{"value":"CONFIGURE_LOGPUSH,CONFIGURE_PAGE_WORKER"}},"in":"query","name":"steps","required":true,"description":"Comma-separated Cloudflare configure steps to re-apply"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/cdn/cloudflare/activation-check":{"put":{"summary":"Check Cloudflare zone and hostname activation status","tags":["Cloudflare"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"zoneStatus":{"type":"string"},"customHostnameStatus":{"type":"string"},"sslStatus":{"type":"string"},"details":{"type":"object","properties":{"errorMessage":{"type":"string"}},"additionalProperties":false}},"required":["zoneStatus","customHostnameStatus"]}}}}}}},"/v2/configs/{id}/cdn/cloudflare/plug":{"post":{"summary":"Plug Cloudflare CDN for the configuration","tags":["Cloudflare"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/cdn/cloudflare/zone":{"get":{"summary":"Get Cloudflare zone id and name for the configuration","tags":["Cloudflare"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"dashboardUrl":{"type":"string"}},"required":["id","name","dashboardUrl"],"additionalProperties":false}}}}}}},"/v2/configs/{id}/cdn/cloudflare/activation-challenges":{"get":{"summary":"Get the validation challenges required to activate Cloudflare for the configuration","tags":["Cloudflare"],"description":"Returns the ownership verification challenges (TXT and/or HTTP) the customer must complete. For platform_loop and gcp modes, returns a zone TXT challenge. For other modes (primary, baseline, secondary, o2o_with_customer_zone), returns custom hostname challenges.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ownershipTxt":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"additionalProperties":false},"ownershipHttp":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"}},"required":["url","body"],"additionalProperties":false}},"additionalProperties":false}}}}}}},"/v2/configs/{id}/cdn/cloudflare/dns-challenge":{"get":{"summary":"Get the DNS TXT verification challenge for a WithPlatformO2O Cloudflare config","tags":["Cloudflare"],"description":"Returns the TXT record name and value the customer must add to their DNS to allow Cloudflare to verify zone ownership. Only available for platform-origin (O2O) configs in PENDING_ACTIVATION state with a zone assigned.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"verificationKey":{"type":"string"},"txtName":{"type":"string"},"txtValue":{"type":"string"},"zoneStatus":{"type":"string"}},"required":["verificationKey","txtName","txtValue"],"additionalProperties":false}}}}}}},"/v2/configs/{id}/cache/purge":{"post":{"summary":"Purge All Files","tags":["Cache Purge"],"description":"Remove ALL files from cache.<br />\n          <b>Note</b> : The asset version is incremented.\n          <small>If a pingback is specified, a response 202 is returned immediately and the actual result is sent to the pingback URL.\n          If no pingback is specified, a response 200 is returned at the end of the operation</small>","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pingback":{"title":"URL called at the end of the operation by a PUT method with the status as JSON object","type":"string","format":"uri","deprecated":true}},"nullable":true}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"details":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["action","status"],"properties":{"action":{"type":"string"},"status":{"type":"string"},"details":{}}}}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"message":{"type":"string"},"operation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}},"/v2/configs/{id}/cache/purge/hosts":{"post":{"summary":"Purge Files by Host","tags":["Cache Purge"],"description":"Any assets at URLs with a host that matches one of the provided values will be purged from the cache.<br />\n          <b>Note</b> : The asset version is incremented.\n          <small>If a pingback is specified, a response 202 is returned immediately and the actual result is sent to the pingback URL.\n          If no pingback is specified, a response 200 is returned at the end of the operation</small>\n          ","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domains"],"properties":{"domains":{"description":"one or multiple primary domains","type":"array","items":{"type":"string","format":"hostname","example":"www.domain.com"},"minItems":1,"maxItems":30},"pingback":{"title":"URL called at the end of the operation by a PUT method with the status as JSON object","type":"string","format":"uri","deprecated":true}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"details":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["action","status"],"properties":{"action":{"type":"string"},"status":{"type":"string"},"details":{}}}}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"message":{"type":"string"},"operation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}},"/v2/configs/{id}/cache/purge/urls":{"post":{"summary":"Purge Files by URL","tags":["Cache Purge"],"description":"Remove one or more files from cache by specifying URLs.<br/>\n          <b>Notes</b> : <br/>\n          - URLs must be page URLs or asset URLs found in optimized pages.\n          - When the page URL is provided, assets within the page are not flushed.\n          - The asset version is not incremented.<br/>\n          <small>If a pingback is specified, a response 202 is returned immediately and the actual result is sent to the pingback URL.\n          If no pingback is specified, a response 200 is returned at the end of the operation</small>","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["urls"],"properties":{"urls":{"description":"assets URLs or page URLs","type":"array","items":{"description":"assets URL or page URL","type":"string","format":"uri","example":"https://www.domain.com/path/image.png?frz-v=2"},"minItems":1,"maxItems":30},"custom_cache_keys":{"description":"An array of custom cache keys that are used to compute the URL cache keys. If not specified, the purge will use custom cache keys defined in the cache settings","type":"array","items":{"type":"string","example":"fr_FR"}},"pingback":{"title":"URL called at the end of the operation by a PUT method with the status as JSON object","type":"string","format":"uri","deprecated":true},"sendOperation":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"urls":{"type":"array","minItems":1,"uniqueItems":true,"items":{"description":"Flushed URLs","type":"string","format":"uri"}},"details":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["action","status"],"properties":{"action":{"type":"string"},"status":{"type":"string"},"details":{}}}}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"urls":{"type":"array","minItems":1,"uniqueItems":true,"items":{"description":"Flushed URLs","type":"string","format":"uri"}},"message":{"type":"string"},"operation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}},"/v2/configs/{id}/cache/purge/tags":{"post":{"summary":"Purge Files by Tag (currently html and asset tag)","tags":["Cache Purge"],"description":"Remove one or more files from cache by specifying a tag.<br/>\n          <b>Note</b> : Two predefined tag is currently supported : <code>asset</code> and <code>html</code> tag.\n          - <code>asset</code> tag is automatically set to images, js, css, font, video, pdf, xml files.\n          - <code>html</code> tag is automatically set to html files.\n          <br/>\n          When the <code>asset</code> tag is specified, all assets files from cache are removed and <b>asset version is incremented</b>.\n          When the <code>html</code> tag is specified, all html files from cache are removed.\n          <br/>\n          <small>\n          If a pingback is specified, a response 202 is returned immediately and the actual result is sent to the pingback URL.\n          If no pingback is specified, a response 200 is returned at the end of the operation\n          </small>","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tag"],"properties":{"tag":{"description":"Tag associated to files","type":"string","enum":["asset","html"]},"pingback":{"title":"URL called at the end of the operation by a PUT method with the status as JSON object","type":"string","format":"uri","deprecated":true}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"tag":{"description":"Tag associated to files","type":"string","enum":["asset","html"]},"details":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["action","status"],"properties":{"action":{"type":"string"},"status":{"type":"string"},"details":{}}}}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"hostname"}},"tag":{"description":"Tag associated to files","type":"string","enum":["asset","html"]},"message":{"type":"string"},"operation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}},"/v2/configs/{id}/cache/purge/directories":{"post":{"summary":"Purge Files by Asset Directory (pseudo wildcard)","tags":["Cache Purge"],"description":"Remove one or more files from cache by specifying a directory.<br/>\n          Any assets at URLs that match the directories will be purged from the cache.\n          This acts as a pseudo wildcard purge or a purge by prefix.<br />\n          <b>Limitation 1</b> : only asset directory is currently supported. The API doesn't support page directory.<br />\n          <b>Limitation 2</b> : this purge is only possible with CDN CloudFront and Incapsula.<br />\n          <small>If a pingback is specified, a response 202 is returned immediately and the actual result is sent to the pingback URL.\n          If no pingback is specified, a response 200 is returned at the end of the operation</small>","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["directories"],"properties":{"directories":{"description":"URL of directories containing asset files","type":"array","items":{"type":"string","format":"uri","example":"https://www.example.com/wp-content"},"minItems":1,"maxItems":30},"pingback":{"title":"URL called at the end of the operation by a PUT method with the status as JSON object","type":"string","format":"uri","deprecated":true}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"directories":{"type":"array","minItems":1,"uniqueItems":true,"items":{"description":"Flushed directories","type":"string","format":"uri"}},"details":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["action","status"],"properties":{"action":{"type":"string"},"status":{"type":"string"},"details":{}}}}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"directories":{"type":"array","minItems":1,"uniqueItems":true,"items":{"description":"Flushed directories","type":"string","format":"uri"}},"message":{"type":"string"},"operation":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}}}},"/v2/configs/{id}/logs":{"get":{"summary":"Retrieve access logs","tags":["Access logs"],"description":"Retrieve the access logs of your account for the last seven days in JSON array, JSON lines,Apache format, or Apache format with response time.","parameters":[{"schema":{"type":"integer"},"example":1600646400,"in":"query","name":"from","required":false,"description":"seconds since unix time - default to the last 15 minutes"},{"schema":{"type":"integer"},"example":1600646400,"in":"query","name":"to","required":false,"description":"seconds since unix time"},{"schema":{"oneOf":[{"type":"array","description":"list of targeted domains","items":{"type":"string"},"default":[]},{"type":"string","description":"targeted domain"}]},"in":"query","name":"domain","required":false},{"schema":{"type":"boolean","default":false},"in":"query","name":"onlySeoVisit","required":false,"description":"filter visitor logs from a search engine (Google, Bing, Baidu, Yandex)"},{"schema":{"type":"boolean","default":false},"in":"query","name":"onlySearchBot","required":false,"description":"filters logs from search engine bot traffic (Google, Bing, Baidu, Yandex)"},{"schema":{"type":"boolean","default":false},"in":"query","name":"onlyAIBot","required":false,"description":"filters logs from AI crawlers and agents (OpenAI, Anthropic, Perplexity, Google, Meta, Mistral, ...) and from visits referred by an AI assistant (ChatGPT, Copilot, Gemini, Perplexity, Claude, ...)"},{"schema":{"type":"string","enum":["json","jsonl","apache","apache_with_response_time"],"default":"json"},"in":"query","name":"format","required":false,"description":"json array, json lines, apache format or apache_with_response_time"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{}}},"/v2/configs/{id}/apps":{"get":{"summary":"Get installed apps","tags":["Websites"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/v2/configs/{id}/apps/target/{target_id}":{"get":{"summary":"Get the applications of a target","tags":["Target"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"home_page","in":"path","name":"target_id","required":true,"description":"Target ID"}],"security":[{"Secret API key":[],"JWT":["application:read","target:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/v2/configs/{id}/apps/tls-certificate/use":{"post":{"summary":"Set certificate for a config","tags":["TLS Certificates"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"query","name":"certificateId","required":true,"description":"Certificate ID"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["certificate:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/bulk-redirection":{"get":{"summary":"Get Bulk Redirection settings","tags":["Bulk Redirection"],"description":"Manage your redirections.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-redirection:read"]}],"responses":{"200":{"description":"The redirection rule allows you to easily set up your HTTP redirections.","content":{"application/json":{"schema":{"type":"object","title":"Bulk Redirection","description":"The redirection rule allows you to easily set up your HTTP redirections.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":true,"properties":{"file_version":{"title":"The version of the file in S3","type":"string","default":""}}}}}}}}}}}},"put":{"summary":"Update Bulk Redirection settings","tags":["Bulk Redirection"],"description":"Manage your redirections.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Bulk Redirection","description":"The redirection rule allows you to easily set up your HTTP redirections.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":true,"properties":{"file_version":{"title":"The version of the file in S3","type":"string","default":""}}}}}}}}},"description":"The redirection rule allows you to easily set up your HTTP redirections."},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-redirection:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/bulk-seo":{"get":{"summary":"Get Bulk Seo settings","tags":["Bulk Seo"],"description":"Apply SEO fundamentals in bulk.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-seo:read"]}],"responses":{"200":{"description":"The seo rule allows you to easily set up fondamental SEO rules","content":{"application/json":{"schema":{"type":"object","title":"Bulk SEO","description":"The seo rule allows you to easily set up fondamental SEO rules","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"file_version":{"title":"The version associated to the uploaded CSV file","type":"string","default":""}}}}}}}}}}}},"put":{"summary":"Update Bulk Seo settings","tags":["Bulk Seo"],"description":"Apply SEO fundamentals in bulk.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Bulk SEO","description":"The seo rule allows you to easily set up fondamental SEO rules","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"file_version":{"title":"The version associated to the uploaded CSV file","type":"string","default":""}}}}}}}}},"description":"The seo rule allows you to easily set up fondamental SEO rules"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-seo:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/bulk-url-rewriting":{"get":{"summary":"Get Bulk Url Rewriting settings","tags":["Bulk Url Rewriting"],"description":"Correct your urls in your pages","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-url-rewriting:read"]}],"responses":{"200":{"description":"This setting allows you to easily set up URL Rewriting rules","content":{"application/json":{"schema":{"type":"object","title":"Bulk URL Rewriting","description":"This setting allows you to easily set up URL Rewriting rules","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"file_version":{"title":"The version associated to the uploaded CSV file","type":"string","default":""}}}}}}}}}}}},"put":{"summary":"Update Bulk Url Rewriting settings","tags":["Bulk Url Rewriting"],"description":"Correct your urls in your pages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Bulk URL Rewriting","description":"This setting allows you to easily set up URL Rewriting rules","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"file_version":{"title":"The version associated to the uploaded CSV file","type":"string","default":""}}}}}}}}},"description":"This setting allows you to easily set up URL Rewriting rules"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-url-rewriting:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/css":{"get":{"summary":"Get Css settings","tags":["Css"],"description":"Optimize your CSS files","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-css:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify CSS","description":"Compacting CSS code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version of the css minificator library","description":"Version is deprecated\nVersion 2 is the updated version that is recommended.\nVersion 3 uses LightningCSS for minification.","default":1,"enum":[1,2,3]}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version of the css minificator library","description":"Version is deprecated\nVersion 2 is the updated version that is recommended.\nVersion 3 uses LightningCSS for minification.","default":1,"enum":[1,2,3]}},"additionalProperties":false}}}}}}}},"concat":{"type":"object","title":"Combine external CSS","description":"Combining external stylesheets into as few files as possible cuts down on RTTs and delays in downloading other resources.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"move_on_top":{"type":"object","title":"Move stylesheet files declarations on top of the page","description":"It ensure that the CSSOM is not blocked by script downloading.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}}}}}}}}},"put":{"summary":"Update Css settings","tags":["Css"],"description":"Optimize your CSS files","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify CSS","description":"Compacting CSS code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version of the css minificator library","description":"Version is deprecated\nVersion 2 is the updated version that is recommended.\nVersion 3 uses LightningCSS for minification.","default":1,"enum":[1,2,3]}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version of the css minificator library","description":"Version is deprecated\nVersion 2 is the updated version that is recommended.\nVersion 3 uses LightningCSS for minification.","default":1,"enum":[1,2,3]}},"additionalProperties":false}}}}}}}},"concat":{"type":"object","title":"Combine external CSS","description":"Combining external stylesheets into as few files as possible cuts down on RTTs and delays in downloading other resources.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"move_on_top":{"type":"object","title":"Move stylesheet files declarations on top of the page","description":"It ensure that the CSSOM is not blocked by script downloading.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-css:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/data-storage":{"get":{"summary":"Get Data Storage settings","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-data-storage:read"]}],"responses":{"200":{"description":"Manage your data storage and your datasets","content":{"application/json":{"schema":{"type":"object","title":"Data Storage","description":"Manage your data storage and your datasets","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"datasets":{"title":"Data sets","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"title":"Name","description":"\"Human name\" for the dataset.","type":"string","maxLength":25,"minLength":1,"example":"My metadatas"},"structuredJSONValues":{"title":"Use JSON values schema validation","description":"If your dataset uses JSON values with the same format for each entry, you can enable this option to activate extra features regarding validation to keep your dataset entries consistent.","type":"boolean","default":false},"id":{"title":"ID","description":"Identifier of the dataset. This property will be used inside the EdgeRewriter's code.","type":"string","pattern":"^[A-Z_]+$","example":"METADATAS"},"app":{"title":"Owning app","description":"App that owns the dataset. When set, the data-storage UI hides it from the dataset list — only the owning app may manage it. Free-form string in the schema (not an enum) because libs-ts' default-filler treats a single-value enum as a default, which would auto-mark every dataset as app-owned. TypeScript narrows the allowed values via `Dataset.app`.","type":"string"}},"required":["name","id"]},"default":[],"uniqueItems":true}}}}}}}}}}}},"put":{"summary":"Update Data Storage settings","tags":["Data Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data Storage","description":"Manage your data storage and your datasets","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"datasets":{"title":"Data sets","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"title":"Name","description":"\"Human name\" for the dataset.","type":"string","maxLength":25,"minLength":1,"example":"My metadatas"},"structuredJSONValues":{"title":"Use JSON values schema validation","description":"If your dataset uses JSON values with the same format for each entry, you can enable this option to activate extra features regarding validation to keep your dataset entries consistent.","type":"boolean","default":false},"id":{"title":"ID","description":"Identifier of the dataset. This property will be used inside the EdgeRewriter's code.","type":"string","pattern":"^[A-Z_]+$","example":"METADATAS"},"app":{"title":"Owning app","description":"App that owns the dataset. When set, the data-storage UI hides it from the dataset list — only the owning app may manage it. Free-form string in the schema (not an enum) because libs-ts' default-filler treats a single-value enum as a default, which would auto-mark every dataset as app-owned. TypeScript narrows the allowed values via `Dataset.app`.","type":"string"}},"required":["name","id"]},"default":[],"uniqueItems":true}}}}}}}}},"description":"Manage your data storage and your datasets"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/domain":{"get":{"summary":"Get Domain settings","tags":["Domain"],"description":"Setup your origin","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-domain:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"primary_domain":{"type":"object","properties":{"domain":{"anyOf":[{"type":"string","format":"hostname"},{"type":"string"}]},"health_check_domain":{"type":"string","format":"hostname"},"origin":{"title":"Origin Domains","description":"The origin is your servers entry point for Fasterize. <br /> Fasterize requests this origin to retrieve the pages for the optimization process.","type":"object","required":["mappings"],"additionalProperties":false,"properties":{"mappings":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["path","mapping"],"additionalProperties":false,"properties":{"path":{"title":"Origin based on URL path","type":"string","format":"regex","default":"^/"},"mapping":{"title":"Origin address","description":"Supported format are common name, cname record, and IPV4 address","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","pattern":".*(?<!(fasterized.com)|(frz.fasterized.net))$","anyOf":[{"format":"ipv4"},{"format":"hostname"},{}]}}}}},"security":{"title":"TLS origin configuration","description":"Ensure that Fasterize connects to the origin with the maximum security. Fasterize supports a wide range of TLS versions and ciphers to ensure wide compatibility with legacy origins","type":"object","additionalProperties":false,"properties":{"force_tls1_1":{"title":"Force a connection to the origin with TLS 1.1","description":"This option is only for legacy origin that doesn't accept other TLS settings","type":"boolean","default":false},"check_cert":{"title":"Check the TLS certificate of the origin","description":"Enable this option to avoid \"man in the middle\" attack between Fasterize and the origin","type":"boolean","default":false}}},"protocol":{"type":"string","title":"Protocol used for the connection","description":"Use HTTP only for staging environment that doesn't have an TLS termination","enum":["incoming","http","https"],"default":"incoming"}}},"virtual_host":{"type":"string","format":"hostname","description":"Override the domain for fronts services"},"dns_origin_failover":{"type":"boolean","title":"DNS origin failover","description":"If you disable this option, the failover will not be performed on the origin if the DNS fallback resolution fails","default":true}},"required":["domain"],"dependencies":{"domain":{"anyOf":[{"properties":{"domain":{"type":"string"},"health_check_domain":{"type":"string","format":"hostname"}},"required":["health_check_domain"]},{"properties":{"domain":{"type":"string","format":"hostname"}}}]}}},"secondary_domains":{"title":"Secondary domains are static domains that should be considered as first party domains","description":"Assets in the domain will be optimized. This domain is not plugged at DNS level","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"domain":{"type":"string","format":"hostname"},"origin":{"title":"Origin Domains","description":"The origin is your servers entry point for Fasterize. <br /> Fasterize requests this origin to retrieve the pages for the optimization process.","type":"object","required":["mappings"],"additionalProperties":false,"properties":{"mappings":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["path","mapping"],"additionalProperties":false,"properties":{"path":{"title":"Origin based on URL path","type":"string","format":"regex","default":"^/"},"mapping":{"title":"Origin address","description":"Supported format are common name, cname record, and IPV4 address","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","pattern":".*(?<!(fasterized.com)|(frz.fasterized.net))$","anyOf":[{"format":"ipv4"},{"format":"hostname"},{}]}}}}},"security":{"title":"TLS origin configuration","description":"Ensure that Fasterize connects to the origin with the maximum security. Fasterize supports a wide range of TLS versions and ciphers to ensure wide compatibility with legacy origins","type":"object","additionalProperties":false,"properties":{"force_tls1_1":{"title":"Force a connection to the origin with TLS 1.1","description":"This option is only for legacy origin that doesn't accept other TLS settings","type":"boolean","default":false},"check_cert":{"title":"Check the TLS certificate of the origin","description":"Enable this option to avoid \"man in the middle\" attack between Fasterize and the origin","type":"boolean","default":false}}},"protocol":{"type":"string","title":"Protocol used for the connection","description":"Use HTTP only for staging environment that doesn't have an TLS termination","enum":["incoming","http","https"],"default":"incoming"}}},"dns_origin_failover":{"type":"boolean","title":"DNS origin failover","description":"If you disable this option, the failover will not be performed on the origin if the DNS fallback resolution fails","default":true}},"required":["domain"]}}}}}}}}},"put":{"summary":"Update Domain settings","tags":["Domain"],"description":"Setup your origin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"primary_domain":{"type":"object","properties":{"domain":{"anyOf":[{"type":"string","format":"hostname"},{"type":"string"}]},"health_check_domain":{"type":"string","format":"hostname"},"origin":{"title":"Origin Domains","description":"The origin is your servers entry point for Fasterize. <br /> Fasterize requests this origin to retrieve the pages for the optimization process.","type":"object","required":["mappings"],"additionalProperties":false,"properties":{"mappings":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["path","mapping"],"additionalProperties":false,"properties":{"path":{"title":"Origin based on URL path","type":"string","format":"regex","default":"^/"},"mapping":{"title":"Origin address","description":"Supported format are common name, cname record, and IPV4 address","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","pattern":".*(?<!(fasterized.com)|(frz.fasterized.net))$","anyOf":[{"format":"ipv4"},{"format":"hostname"},{}]}}}}},"security":{"title":"TLS origin configuration","description":"Ensure that Fasterize connects to the origin with the maximum security. Fasterize supports a wide range of TLS versions and ciphers to ensure wide compatibility with legacy origins","type":"object","additionalProperties":false,"properties":{"force_tls1_1":{"title":"Force a connection to the origin with TLS 1.1","description":"This option is only for legacy origin that doesn't accept other TLS settings","type":"boolean","default":false},"check_cert":{"title":"Check the TLS certificate of the origin","description":"Enable this option to avoid \"man in the middle\" attack between Fasterize and the origin","type":"boolean","default":false}}},"protocol":{"type":"string","title":"Protocol used for the connection","description":"Use HTTP only for staging environment that doesn't have an TLS termination","enum":["incoming","http","https"],"default":"incoming"}}},"virtual_host":{"type":"string","format":"hostname","description":"Override the domain for fronts services"},"dns_origin_failover":{"type":"boolean","title":"DNS origin failover","description":"If you disable this option, the failover will not be performed on the origin if the DNS fallback resolution fails","default":true}},"required":["domain"],"dependencies":{"domain":{"anyOf":[{"properties":{"domain":{"type":"string"},"health_check_domain":{"type":"string","format":"hostname"}},"required":["health_check_domain"]},{"properties":{"domain":{"type":"string","format":"hostname"}}}]}}},"secondary_domains":{"title":"Secondary domains are static domains that should be considered as first party domains","description":"Assets in the domain will be optimized. This domain is not plugged at DNS level","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"domain":{"type":"string","format":"hostname"},"origin":{"title":"Origin Domains","description":"The origin is your servers entry point for Fasterize. <br /> Fasterize requests this origin to retrieve the pages for the optimization process.","type":"object","required":["mappings"],"additionalProperties":false,"properties":{"mappings":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["path","mapping"],"additionalProperties":false,"properties":{"path":{"title":"Origin based on URL path","type":"string","format":"regex","default":"^/"},"mapping":{"title":"Origin address","description":"Supported format are common name, cname record, and IPV4 address","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","pattern":".*(?<!(fasterized.com)|(frz.fasterized.net))$","anyOf":[{"format":"ipv4"},{"format":"hostname"},{}]}}}}},"security":{"title":"TLS origin configuration","description":"Ensure that Fasterize connects to the origin with the maximum security. Fasterize supports a wide range of TLS versions and ciphers to ensure wide compatibility with legacy origins","type":"object","additionalProperties":false,"properties":{"force_tls1_1":{"title":"Force a connection to the origin with TLS 1.1","description":"This option is only for legacy origin that doesn't accept other TLS settings","type":"boolean","default":false},"check_cert":{"title":"Check the TLS certificate of the origin","description":"Enable this option to avoid \"man in the middle\" attack between Fasterize and the origin","type":"boolean","default":false}}},"protocol":{"type":"string","title":"Protocol used for the connection","description":"Use HTTP only for staging environment that doesn't have an TLS termination","enum":["incoming","http","https"],"default":"incoming"}}},"dns_origin_failover":{"type":"boolean","title":"DNS origin failover","description":"If you disable this option, the failover will not be performed on the origin if the DNS fallback resolution fails","default":true}},"required":["domain"]}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-domain:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/dtdm":{"get":{"summary":"Get Datadome settings","tags":["Datadome"],"description":"Connect your Datadome account","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-dtdm:read"]}],"responses":{"200":{"description":"Datadome analyses the incoming traffic in real time. Fasterize offers a simple integration for your Datadome account","content":{"application/json":{"schema":{"type":"object","title":"Integrate Datadome - the anti bot solution","description":"Datadome analyses the incoming traffic in real time. Fasterize offers a simple integration for your Datadome account","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","required":["api_key","excluded_paths"],"additionalProperties":false,"properties":{"api_key":{"title":"API Key from Datadome","type":"string","default":""},"client_key":{"title":"JS Key from Datadome","type":"string","default":""},"inject_script":{"title":"If true then the datadome script is injected into the page","type":"boolean","default":false},"config":{"title":"Datadome configuration","type":"string","default":""},"excluded_paths":{"type":"array","default":[],"uniqueItems":true,"items":{"title":"Path that should not be controlled by Datadome","type":"string","minLength":1}},"static_files_whitelist_paths":{"title":"Allows the analysis of a URL even if it ends with an extension typically associated with a static file, which would normally be excluded. However, if the URL is excluded via the excluded_paths option, it will remain excluded.","type":"array","default":[],"uniqueItems":true,"items":{"title":"The starting path of requests that should be controllered by Datadome even if its ending by a static file extension","type":"string","minLength":1}}}}}}}}}}}}},"put":{"summary":"Update Datadome settings","tags":["Datadome"],"description":"Connect your Datadome account","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Integrate Datadome - the anti bot solution","description":"Datadome analyses the incoming traffic in real time. Fasterize offers a simple integration for your Datadome account","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","required":["api_key","excluded_paths"],"additionalProperties":false,"properties":{"api_key":{"title":"API Key from Datadome","type":"string","default":""},"client_key":{"title":"JS Key from Datadome","type":"string","default":""},"inject_script":{"title":"If true then the datadome script is injected into the page","type":"boolean","default":false},"config":{"title":"Datadome configuration","type":"string","default":""},"excluded_paths":{"type":"array","default":[],"uniqueItems":true,"items":{"title":"Path that should not be controlled by Datadome","type":"string","minLength":1}},"static_files_whitelist_paths":{"title":"Allows the analysis of a URL even if it ends with an extension typically associated with a static file, which would normally be excluded. However, if the URL is excluded via the excluded_paths option, it will remain excluded.","type":"array","default":[],"uniqueItems":true,"items":{"title":"The starting path of requests that should be controllered by Datadome even if its ending by a static file extension","type":"string","minLength":1}}}}}}}}}},"description":"Datadome analyses the incoming traffic in real time. Fasterize offers a simple integration for your Datadome account"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-dtdm:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/edge-rewriter":{"get":{"summary":"Get Edge Rewriter settings","tags":["Edge Rewriter"],"description":"Change DOM","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-edge-rewriter:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","title":"Add a script to modify the html","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string","default":"//LCP\n\nconst body = document.querySelector('body');\nconst head = document.querySelector('head');\n\n if (body) { domUtils.prependInside(body, '<img fetchpriority=\"high\" alt=\".\" width=\"1000\" height=\"1000\" style=\"pointer-events: none; position: absolute; top: 0; left: 0; width: 1000px; height: 1000px; max-width: 99vw; max-height: 99vh;\"  src=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />') };\n\n if (head) { domUtils.prependInside(head, '<link rel=\"preload\" as=\"image\" fetchpriority=\"high\" href=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />')};"},"version":{"type":"integer","default":1,"enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"},"default":["body","head","script"]}}}}},"common_settings":{"title":"Settings that are common to all targets.","type":"object","properties":{"global_script":{"title":"Global script declaration","description":"You can declare here global functions and variables, that will be reusable in target settings scripts","type":"string","default":""}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string","default":"//LCP\n\nconst body = document.querySelector('body');\nconst head = document.querySelector('head');\n\n if (body) { domUtils.prependInside(body, '<img fetchpriority=\"high\" alt=\".\" width=\"1000\" height=\"1000\" style=\"pointer-events: none; position: absolute; top: 0; left: 0; width: 1000px; height: 1000px; max-width: 99vw; max-height: 99vh;\"  src=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />') };\n\n if (head) { domUtils.prependInside(head, '<link rel=\"preload\" as=\"image\" fetchpriority=\"high\" href=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />')};"},"version":{"type":"integer","default":1,"enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"},"default":["body","head","script"]}}}}}}}}}}}}}}},"put":{"summary":"Update Edge Rewriter settings","tags":["Edge Rewriter"],"description":"Change DOM","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Add a script to modify the html","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string","default":"//LCP\n\nconst body = document.querySelector('body');\nconst head = document.querySelector('head');\n\n if (body) { domUtils.prependInside(body, '<img fetchpriority=\"high\" alt=\".\" width=\"1000\" height=\"1000\" style=\"pointer-events: none; position: absolute; top: 0; left: 0; width: 1000px; height: 1000px; max-width: 99vw; max-height: 99vh;\"  src=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />') };\n\n if (head) { domUtils.prependInside(head, '<link rel=\"preload\" as=\"image\" fetchpriority=\"high\" href=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />')};"},"version":{"type":"integer","default":1,"enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"},"default":["body","head","script"]}}}}},"common_settings":{"title":"Settings that are common to all targets.","type":"object","properties":{"global_script":{"title":"Global script declaration","description":"You can declare here global functions and variables, that will be reusable in target settings scripts","type":"string","default":""}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string","default":"//LCP\n\nconst body = document.querySelector('body');\nconst head = document.querySelector('head');\n\n if (body) { domUtils.prependInside(body, '<img fetchpriority=\"high\" alt=\".\" width=\"1000\" height=\"1000\" style=\"pointer-events: none; position: absolute; top: 0; left: 0; width: 1000px; height: 1000px; max-width: 99vw; max-height: 99vh;\"  src=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />') };\n\n if (head) { domUtils.prependInside(head, '<link rel=\"preload\" as=\"image\" fetchpriority=\"high\" href=\"https://' + window.location.host + '/fstrz/r/s/edgepic.fzcdn.net/8c81b980ca.svg\" />')};"},"version":{"type":"integer","default":1,"enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"},"default":["body","head","script"]}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-edge-rewriter:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/firewall":{"get":{"summary":"Get Firewall settings","tags":["Firewall"],"description":"Secure your trafic","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-firewall:read"]}],"responses":{"200":{"description":"Access control by IP filtering, User-Agent matching or country","content":{"application/json":{"schema":{"type":"object","title":"Firewall","description":"Access control by IP filtering, User-Agent matching or country","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"whitelist":{"title":"List of authorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"blacklist":{"title":"List of unauthorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"default_action":{"title":"Default action for client IP access control","description":"allow means that the whitelist act as a skiplist at the WAF level - useful for production website. block means that only the whitelist is allowed and all the other traffic is blocked - useful for staging or pre-production website","type":"string","enum":["allow","block"],"default":"allow"}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"whitelist":{"title":"List of authorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"blacklist":{"title":"List of unauthorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}}}},"user_agent":{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"blacklist":{"title":"List of unauthorized User-Agent","description":"We block requests matching User-Agent","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}}}},"country":{"title":"ISO 3166-1 Alpha-2 Country code","type":"object","additionalProperties":false,"properties":{"blacklist":{"title":"List of unauthorized countries","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}}}}}}}}}}}}}}}},"put":{"summary":"Update Firewall settings","tags":["Firewall"],"description":"Secure your trafic","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Firewall","description":"Access control by IP filtering, User-Agent matching or country","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"whitelist":{"title":"List of authorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"blacklist":{"title":"List of unauthorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"default_action":{"title":"Default action for client IP access control","description":"allow means that the whitelist act as a skiplist at the WAF level - useful for production website. block means that only the whitelist is allowed and all the other traffic is blocked - useful for staging or pre-production website","type":"string","enum":["allow","block"],"default":"allow"}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"whitelist":{"title":"List of authorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}},"blacklist":{"title":"List of unauthorized IP","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}}}},"user_agent":{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"blacklist":{"title":"List of unauthorized User-Agent","description":"We block requests matching User-Agent","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string"}}}}}}},"country":{"title":"ISO 3166-1 Alpha-2 Country code","type":"object","additionalProperties":false,"properties":{"blacklist":{"title":"List of unauthorized countries","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Access rule label"},"enabled":{"type":"boolean","title":"Access rule activation","default":true},"target":{"type":"array","title":"Access rule list","minItems":1,"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}}}}}}}}}}}}},"description":"Access control by IP filtering, User-Agent matching or country"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-firewall:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/font":{"get":{"summary":"Get Font settings","tags":["Font"],"description":"Optimize your fonts","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-font:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"font_face":{"type":"object","title":"Optimize font loading","description":"Generate WOFF and WOFF2 formats, subset resources, autohint them and add font-display declaration","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_missing_format":{"title":"Add missing WOFF2 and WOFF formats","type":"boolean","default":false},"insert_font_display":{"title":"Add font-display declaration","type":"boolean","default":false},"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"extract_inline_source":{"title":"Extract inlined font source","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_missing_format":{"title":"Add missing WOFF2 and WOFF formats","type":"boolean","default":false},"insert_font_display":{"title":"Add font-display declaration","type":"boolean","default":false},"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"extract_inline_source":{"title":"Extract inlined font source","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"google_fonts":{"type":"object","title":"Optimize Google fonts","description":"Improve Google Fonts CSS loader","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"async_load":{"title":"Load CSS asynchronously","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"async_load":{"title":"Load CSS asynchronously","type":"boolean","default":false}}}}}}}}}},"subset":{"type":"object","title":"Subset fonts by removing unused glyphs","description":"Subsetting fonts is the process of taking a large font file as input and creating other smaller files, with fewer characters","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"unicode_ranges":{"title":"Choose character sets on an unicode range","type":"array","default":["latin"],"minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["latin","latin-ext","arabic","cyrillic","cyrillic-ext","greek","greek-ext","hebrew"]}},"languages":{"title":"Choose character sets used for a given language","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","enum":["french","german","english","italian","dutch","spanish","portuguese","albanian","bosnian","catalan","croatian","czech","danish","estonian","faroese","hungarian","icelandic","latvian","lithuanian","malagasy","maltese","norwegian","polish","romanian","serbian","slovak","slovenian","swedish","turkish"]}}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"unicode_ranges":{"title":"Choose character sets on an unicode range","type":"array","default":["latin"],"minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["latin","latin-ext","arabic","cyrillic","cyrillic-ext","greek","greek-ext","hebrew"]}},"languages":{"title":"Choose character sets used for a given language","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","enum":["french","german","english","italian","dutch","spanish","portuguese","albanian","bosnian","catalan","croatian","czech","danish","estonian","faroese","hungarian","icelandic","latvian","lithuanian","malagasy","maltese","norwegian","polish","romanian","serbian","slovak","slovenian","swedish","turkish"]}}},"additionalProperties":false}}}}}}}}}}}}}}},"put":{"summary":"Update Font settings","tags":["Font"],"description":"Optimize your fonts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"font_face":{"type":"object","title":"Optimize font loading","description":"Generate WOFF and WOFF2 formats, subset resources, autohint them and add font-display declaration","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_missing_format":{"title":"Add missing WOFF2 and WOFF formats","type":"boolean","default":false},"insert_font_display":{"title":"Add font-display declaration","type":"boolean","default":false},"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"extract_inline_source":{"title":"Extract inlined font source","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_missing_format":{"title":"Add missing WOFF2 and WOFF formats","type":"boolean","default":false},"insert_font_display":{"title":"Add font-display declaration","type":"boolean","default":false},"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"extract_inline_source":{"title":"Extract inlined font source","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"google_fonts":{"type":"object","title":"Optimize Google fonts","description":"Improve Google Fonts CSS loader","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"async_load":{"title":"Load CSS asynchronously","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"font_display_value":{"type":"string","title":"Choose the value for font-display","enum":["auto","block","swap","fallback","optional"],"default":"swap"},"async_load":{"title":"Load CSS asynchronously","type":"boolean","default":false}}}}}}}}}},"subset":{"type":"object","title":"Subset fonts by removing unused glyphs","description":"Subsetting fonts is the process of taking a large font file as input and creating other smaller files, with fewer characters","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"unicode_ranges":{"title":"Choose character sets on an unicode range","type":"array","default":["latin"],"minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["latin","latin-ext","arabic","cyrillic","cyrillic-ext","greek","greek-ext","hebrew"]}},"languages":{"title":"Choose character sets used for a given language","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","enum":["french","german","english","italian","dutch","spanish","portuguese","albanian","bosnian","catalan","croatian","czech","danish","estonian","faroese","hungarian","icelandic","latvian","lithuanian","malagasy","maltese","norwegian","polish","romanian","serbian","slovak","slovenian","swedish","turkish"]}}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"unicode_ranges":{"title":"Choose character sets on an unicode range","type":"array","default":["latin"],"minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["latin","latin-ext","arabic","cyrillic","cyrillic-ext","greek","greek-ext","hebrew"]}},"languages":{"title":"Choose character sets used for a given language","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","enum":["french","german","english","italian","dutch","spanish","portuguese","albanian","bosnian","catalan","croatian","czech","danish","estonian","faroese","hungarian","icelandic","latvian","lithuanian","malagasy","maltese","norwegian","polish","romanian","serbian","slovak","slovenian","swedish","turkish"]}}},"additionalProperties":false}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-font:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/geoip":{"get":{"summary":"Get Geo IP settings","tags":["Geo IP"],"description":"Geolocate your users","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-geoip:read"]}],"responses":{"200":{"description":"Get Country of the user based on the IP address","content":{"application/json":{"schema":{"type":"object","title":"IP Geolocation","description":"Get Country of the user based on the IP address","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"header":{"type":"boolean","default":true},"query_parameter":{"type":"boolean","default":false}}}}}}}}}}}},"put":{"summary":"Update Geo IP settings","tags":["Geo IP"],"description":"Geolocate your users","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"IP Geolocation","description":"Get Country of the user based on the IP address","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"header":{"type":"boolean","default":true},"query_parameter":{"type":"boolean","default":false}}}}}}}}},"description":"Get Country of the user based on the IP address"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-geoip:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/html-tag":{"get":{"summary":"Get HTML settings","tags":["HTML"],"description":"Optimize your HTML","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-html-tag:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify HTML","description":"Compacting HTML code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"keep_comment":{"type":"boolean","default":true}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"keep_comment":{"type":"boolean","default":true}}}}}}}}}},"html_tag":{"type":"object","additionalProperties":false,"properties":{"image_url_attributes":{"type":"object","title":"Optimize images in custom HTML tags","description":"Optimize image resource located in custom HTML tags","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"attributes":{"title":"Custom attributes","type":"array","default":[],"items":{"type":"string","minLength":1}},"tags":{"title":"Custom tags","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"attributes":{"title":"Custom attributes","type":"array","default":[],"items":{"type":"string","minLength":1}},"tags":{"title":"Custom tags","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}}}}}}},"closing_body_tag":{"type":"object","title":"HTML injected before the </body> tag","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"}}}}}}}}}},"closing_head_tag":{"type":"object","title":"HTML injected before </head>","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string","default":"<script> if (navigator.userAgent.indexOf(\"Lighthouse\") !== -1 || navigator.userAgent.indexOf(\"moto g\") !== -1) {window.fasterizeNs = {blockDeferJsStart: true}} </script>\n"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string","default":"<script> if (navigator.userAgent.indexOf(\"Lighthouse\") !== -1 || navigator.userAgent.indexOf(\"moto g\") !== -1) {window.fasterizeNs = {blockDeferJsStart: true}} </script>\n"}}}}}}}}}},"opening_head_tag":{"type":"object","title":"HTML injected after <head>","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"after":{"type":"string"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"after":{"type":"string"}}}}}}}}}},"modify":{"type":"object","title":"Edit tags in the page","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"operations":{"title":"Possible operations on HTML tags","type":"array","default":[],"items":{"anyOf":[{"type":"object","required":["action","tag"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside","wrap_inside","wrap_outside","replace","wrap"]},"tag":{"type":"string","minLength":1}}},{"type":"object","required":["action"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["unwrap","empty","remove"]}}}]}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"operations":{"title":"Possible operations on HTML tags","type":"array","default":[],"items":{"anyOf":[{"type":"object","required":["action","tag"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside","wrap_inside","wrap_outside","replace","wrap"]},"tag":{"type":"string","minLength":1}}},{"type":"object","required":["action"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["unwrap","empty","remove"]}}}]}}}}}}}}}}}}},"internal_engine_cache":{"type":"object","title":"Dynamic caching activation","description":"Avoid unnecessary page optimization","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ignore_patterns":{"type":"array","default":[],"items":{"type":"string","format":"regex"}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ignore_patterns":{"type":"array","default":[],"items":{"type":"string","format":"regex"}}}}}}}}}}},"tag_removal":{"type":"object","title":"Remove tags from page","description":"Automatically remove tags from page","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"resource_hints":{"type":"object","additionalProperties":false,"properties":{"preconnect":{"title":"Remove preconnect tags","type":"boolean","default":false},"prefetch":{"title":"Remove prefetch tags","type":"boolean","default":false},"preload":{"title":"Remove preload tags","type":"boolean","default":false},"dns_prefetch":{"title":"Remove dns prefetch tags","type":"boolean","default":false}}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"resource_hints":{"type":"object","additionalProperties":false,"properties":{"preconnect":{"title":"Remove preconnect tags","type":"boolean","default":false},"prefetch":{"title":"Remove prefetch tags","type":"boolean","default":false},"preload":{"title":"Remove preload tags","type":"boolean","default":false},"dns_prefetch":{"title":"Remove dns prefetch tags","type":"boolean","default":false}}}}}}}}}}}}}}}}}}},"put":{"summary":"Update HTML settings","tags":["HTML"],"description":"Optimize your HTML","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify HTML","description":"Compacting HTML code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"keep_comment":{"type":"boolean","default":true}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"keep_comment":{"type":"boolean","default":true}}}}}}}}}},"html_tag":{"type":"object","additionalProperties":false,"properties":{"image_url_attributes":{"type":"object","title":"Optimize images in custom HTML tags","description":"Optimize image resource located in custom HTML tags","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"attributes":{"title":"Custom attributes","type":"array","default":[],"items":{"type":"string","minLength":1}},"tags":{"title":"Custom tags","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"attributes":{"title":"Custom attributes","type":"array","default":[],"items":{"type":"string","minLength":1}},"tags":{"title":"Custom tags","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}}}}}}},"closing_body_tag":{"type":"object","title":"HTML injected before the </body> tag","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"}}}}}}}}}},"closing_head_tag":{"type":"object","title":"HTML injected before </head>","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string","default":"<script> if (navigator.userAgent.indexOf(\"Lighthouse\") !== -1 || navigator.userAgent.indexOf(\"moto g\") !== -1) {window.fasterizeNs = {blockDeferJsStart: true}} </script>\n"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string","default":"<script> if (navigator.userAgent.indexOf(\"Lighthouse\") !== -1 || navigator.userAgent.indexOf(\"moto g\") !== -1) {window.fasterizeNs = {blockDeferJsStart: true}} </script>\n"}}}}}}}}}},"opening_head_tag":{"type":"object","title":"HTML injected after <head>","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"after":{"type":"string"}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"after":{"type":"string"}}}}}}}}}},"modify":{"type":"object","title":"Edit tags in the page","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"operations":{"title":"Possible operations on HTML tags","type":"array","default":[],"items":{"anyOf":[{"type":"object","required":["action","tag"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside","wrap_inside","wrap_outside","replace","wrap"]},"tag":{"type":"string","minLength":1}}},{"type":"object","required":["action"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["unwrap","empty","remove"]}}}]}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"operations":{"title":"Possible operations on HTML tags","type":"array","default":[],"items":{"anyOf":[{"type":"object","required":["action","tag"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside","wrap_inside","wrap_outside","replace","wrap"]},"tag":{"type":"string","minLength":1}}},{"type":"object","required":["action"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["unwrap","empty","remove"]}}}]}}}}}}}}}}}}},"internal_engine_cache":{"type":"object","title":"Dynamic caching activation","description":"Avoid unnecessary page optimization","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ignore_patterns":{"type":"array","default":[],"items":{"type":"string","format":"regex"}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ignore_patterns":{"type":"array","default":[],"items":{"type":"string","format":"regex"}}}}}}}}}}},"tag_removal":{"type":"object","title":"Remove tags from page","description":"Automatically remove tags from page","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"resource_hints":{"type":"object","additionalProperties":false,"properties":{"preconnect":{"title":"Remove preconnect tags","type":"boolean","default":false},"prefetch":{"title":"Remove prefetch tags","type":"boolean","default":false},"preload":{"title":"Remove preload tags","type":"boolean","default":false},"dns_prefetch":{"title":"Remove dns prefetch tags","type":"boolean","default":false}}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"resource_hints":{"type":"object","additionalProperties":false,"properties":{"preconnect":{"title":"Remove preconnect tags","type":"boolean","default":false},"prefetch":{"title":"Remove prefetch tags","type":"boolean","default":false},"preload":{"title":"Remove preload tags","type":"boolean","default":false},"dns_prefetch":{"title":"Remove dns prefetch tags","type":"boolean","default":false}}}}}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-html-tag:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/http-header":{"get":{"summary":"Get HTTP Header settings","tags":["HTTP Header"],"description":"Manage your HTTP header","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-http-header:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"origin_response":{"type":"object","title":"Modify HTTP headers received by the origin","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"remove":{"title":"Remove a given HTTP header","type":"array","items":{"type":"string","pattern":"^[\\w-]+$"}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"remove":{"title":"Remove a given HTTP header","type":"array","items":{"type":"string","pattern":"^[\\w-]+$"}}}}}}}}}}},"origin_request":{"type":"object","title":"Modify HTTP headers sent to the origin","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"upsert":{"title":"Insert or replace the given header","type":"object","additionalProperties":{"type":"string"}},"upsert_headers":{"title":"Insert or replace the given header","type":"array","items":{"type":"object","properties":{"key":{"title":"Header key","type":"string","pattern":"^[\\w-]+$"},"value":{"title":"Header value","type":"string","minLength":1}}}},"extra_client_ip_header":{"title":"Optional header for the Client IP address","description":"Useful if origin only read client IP in a custom header such as X-Real-IP. Fasterize send the origin header in both X-Forwarded-For header and True-Client-IP header","oneOf":[{"type":"string","pattern":"^[\\w-]+$","not":{"enum":["true-client-ip","x-forwarded-for"]},"minLength":1},{"type":"string","maxLength":0}]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"upsert":{"title":"Insert or replace the given header","type":"object","additionalProperties":{"type":"string"}},"upsert_headers":{"title":"Insert or replace the given header","type":"array","items":{"type":"object","properties":{"key":{"title":"Header key","type":"string","pattern":"^[\\w-]+$"},"value":{"title":"Header value","type":"string","minLength":1}}}},"extra_client_ip_header":{"title":"Optional header for the Client IP address","description":"Useful if origin only read client IP in a custom header such as X-Real-IP. Fasterize send the origin header in both X-Forwarded-For header and True-Client-IP header","oneOf":[{"type":"string","pattern":"^[\\w-]+$","not":{"enum":["true-client-ip","x-forwarded-for"]},"minLength":1},{"type":"string","maxLength":0}]}}}}}}}}}}}}}}}}},"put":{"summary":"Update HTTP Header settings","tags":["HTTP Header"],"description":"Manage your HTTP header","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"origin_response":{"type":"object","title":"Modify HTTP headers received by the origin","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"remove":{"title":"Remove a given HTTP header","type":"array","items":{"type":"string","pattern":"^[\\w-]+$"}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"remove":{"title":"Remove a given HTTP header","type":"array","items":{"type":"string","pattern":"^[\\w-]+$"}}}}}}}}}}},"origin_request":{"type":"object","title":"Modify HTTP headers sent to the origin","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"upsert":{"title":"Insert or replace the given header","type":"object","additionalProperties":{"type":"string"}},"upsert_headers":{"title":"Insert or replace the given header","type":"array","items":{"type":"object","properties":{"key":{"title":"Header key","type":"string","pattern":"^[\\w-]+$"},"value":{"title":"Header value","type":"string","minLength":1}}}},"extra_client_ip_header":{"title":"Optional header for the Client IP address","description":"Useful if origin only read client IP in a custom header such as X-Real-IP. Fasterize send the origin header in both X-Forwarded-For header and True-Client-IP header","oneOf":[{"type":"string","pattern":"^[\\w-]+$","not":{"enum":["true-client-ip","x-forwarded-for"]},"minLength":1},{"type":"string","maxLength":0}]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"upsert":{"title":"Insert or replace the given header","type":"object","additionalProperties":{"type":"string"}},"upsert_headers":{"title":"Insert or replace the given header","type":"array","items":{"type":"object","properties":{"key":{"title":"Header key","type":"string","pattern":"^[\\w-]+$"},"value":{"title":"Header value","type":"string","minLength":1}}}},"extra_client_ip_header":{"title":"Optional header for the Client IP address","description":"Useful if origin only read client IP in a custom header such as X-Real-IP. Fasterize send the origin header in both X-Forwarded-For header and True-Client-IP header","oneOf":[{"type":"string","pattern":"^[\\w-]+$","not":{"enum":["true-client-ip","x-forwarded-for"]},"minLength":1},{"type":"string","maxLength":0}]}}}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-http-header:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/image":{"get":{"summary":"Get Image settings","tags":["Image"],"description":"Optimize your images","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-image:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"optimization":{"type":"object","additionalProperties":false,"properties":{"optimize_gif":{"type":"object","title":"compression of GIF images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"compression_rate":{"title":"Lossiness","description":"Lossiness determines how many artifacts are allowed","type":"integer","minimum":30,"maximum":200,"default":50}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"compression_rate":{"title":"Lossiness","description":"Lossiness determines how many artifacts are allowed","type":"integer","minimum":30,"maximum":200,"default":50}},"additionalProperties":false}}}}}}}},"optimize_jpeg":{"type":"object","title":"compression of JPEG images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"progressive":{"title":"Encode image in progressive mode","description":"A progressive JPEG will actually show the entire image right away at low resolution. As loading proceeds, the image becomes sharper.","type":"boolean","default":false},"strip_metadata":{"title":"Strip Metadata","description":"Remove auxiliary information about the image such as thumbnails, copyright information while keeping orientation and color profile","type":"boolean","default":false},"automatic_quality_detection":{"title":"Automatic quality detection","description":"Figure out which quality setting is best for each image based on artifact detection algorithm while keeping perceived visual quality the same","type":"boolean","default":false},"quality":{"type":"integer","title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":80},"automatic_quality_preset":{"type":"string","title":"Automatic quality sensitivity","description":"Give the level of accuracy between the optimized image and the original image","enum":["low","medium","high","veryhigh"],"default":"medium"},"min_automatic_quality":{"type":"integer","title":"Minimum quality level for automatic detection","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":75}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"progressive":{"title":"Encode image in progressive mode","description":"A progressive JPEG will actually show the entire image right away at low resolution. As loading proceeds, the image becomes sharper.","type":"boolean","default":false},"strip_metadata":{"title":"Strip Metadata","description":"Remove auxiliary information about the image such as thumbnails, copyright information while keeping orientation and color profile","type":"boolean","default":false},"automatic_quality_detection":{"title":"Automatic quality detection","description":"Figure out which quality setting is best for each image based on artifact detection algorithm while keeping perceived visual quality the same","type":"boolean","default":false},"quality":{"type":"integer","title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":80},"automatic_quality_preset":{"type":"string","title":"Automatic quality sensitivity","description":"Give the level of accuracy between the optimized image and the original image","enum":["low","medium","high","veryhigh"],"default":"medium"},"min_automatic_quality":{"type":"integer","title":"Minimum quality level for automatic detection","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":75}},"additionalProperties":false}}}}}}}},"optimize_png":{"type":"object","title":"Lossless compression of PNG images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_png24_to_png8":{"type":"boolean","title":"convert any PNG-24 image into an alpha PNG-8","description":"The conversion reduces file sizes significantly (often as much as 70%) and preserves full alpha transparency","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_png24_to_png8":{"type":"boolean","title":"convert any PNG-24 image into an alpha PNG-8","description":"The conversion reduces file sizes significantly (often as much as 70%) and preserves full alpha transparency","default":false}},"additionalProperties":false}}}}}}}},"optimize_svg":{"type":"object","title":"compression of SVG images","description":"SVG files, especially those exported from various editors, usually contain a lot of redundant and useless information. This can include editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting the SVG rendering result.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Optimizer version","description":"Two existing version : 1 for the version released in 2017 and 2 for the version released in 2020"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Optimizer version","description":"Two existing version : 1 for the version released in 2017 and 2 for the version released in 2020"}},"additionalProperties":false}}}}}}}},"optimize_webp":{"type":"object","title":"compression of WebP images","description":"WebP is a modern format that replace JPEG and PNG. It is supported by all major browsers","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a WebP copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for WebP","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":80},"alpha_quality":{"title":"Quality of alpha layer","description":"The alpha layer is the layer for the transparency part of the image","type":"integer","minimum":0,"maximum":100,"default":100},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"near_lossless":{"title":"Level of near-lossless image preprocessing","description":"This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically.","type":"boolean","default":false},"smart_subsample":{"title":"Smart Subsampling","description":"Use high quality chroma subsampling","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a WebP copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for WebP","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":80},"alpha_quality":{"title":"Quality of alpha layer","description":"The alpha layer is the layer for the transparency part of the image","type":"integer","minimum":0,"maximum":100,"default":100},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"near_lossless":{"title":"Level of near-lossless image preprocessing","description":"This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically.","type":"boolean","default":false},"smart_subsample":{"title":"Smart Subsampling","description":"Use high quality chroma subsampling","type":"boolean","default":false}}}}}}}}}},"optimize_avif":{"type":"object","title":"compression of AVIF images","description":"New image format derived from the keyframes of AV1 video","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a AVIF copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for AVIF","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":50},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"chroma_subsampling":{"title":"Chroma subsampling","description":"set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling","type":"string","default":"4:2:0","enum":["4:2:0","4:4:4"]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a AVIF copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for AVIF","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":50},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"chroma_subsampling":{"title":"Chroma subsampling","description":"set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling","type":"string","default":"4:2:0","enum":["4:2:0","4:4:4"]}}}}}}}}}}}},"resize":{"type":"object","title":"Resize images via query parameters","description":"Use query parameters in the image URL to resize it. Parameters are frz-width, frz-height, frz-fit, frz-gravity and frz-enlarge","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"operations":{"type":"object","title":"Image operations","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"sharpen":{"title":"Sharpen the image","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"sharpen":{"title":"Sharpen the image","type":"boolean","default":false}}}}}}}}}},"img_dimensions_attr":{"type":"object","title":"Generate width and height for img tag in html","description":"Analyze your images and store their width and height in the img tag to improve CLS","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"img_url_attr":{"type":"object","title":"Extend image optimizations to images in custom HTML tags","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"tags":{"title":"Tags","description":"HTML tags that can have an atttribute containing an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}},"attributes":{"title":"Attributes","description":"HTML tag attributes that can contain an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"tags":{"title":"Tags","description":"HTML tags that can have an atttribute containing an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}},"attributes":{"title":"Attributes","description":"HTML tag attributes that can contain an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}}}}}}},"delivery":{"type":"object","additionalProperties":false,"properties":{"lazyload":{"type":"object","title":"Images lazyloading","description":"Deferring loading of images reduce the render time","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"version":{"title":"Version of the lazyload library","description":"The version 2 of the lazyloader supports elements that are dynamically injected in the DOM.","type":"integer","default":1,"enum":[1,2,3]},"offset":{"title":"Number of images to skip","description":"The lazyloader will not be active on the first Nth images.","type":"integer","default":5}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"version":{"title":"Version of the lazyload library","description":"The version 2 of the lazyloader supports elements that are dynamically injected in the DOM.","type":"integer","default":1,"enum":[1,2,3]},"offset":{"title":"Number of images to skip","description":"The lazyloader will not be active on the first Nth images.","type":"integer","default":5}}}}}}}}}},"responsive":{"type":"object","title":"Images responsible","description":"Automatically adjusts the image size to fit the screen.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"offset":{"title":"Number of images to skip","description":"The Responsive will not be active on the first Nth images.","type":"integer","default":5}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"offset":{"title":"Number of images to skip","description":"The Responsive will not be active on the first Nth images.","type":"integer","default":5}}}}}}}}}},"inlining":{"type":"object","title":"Inline the small images directly in the page","description":"It permits to save the request time. It's particularly important for the mobile site.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"unlazyload":{"type":"object","title":"Remove the lazyloader used at the origin","description":"This is useful when the lazyloader is applied on critical images","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"class":{"title":"Remove a class name on the class attribute","type":"string","default":"lazyload"},"src":{"title":"Attribute used to build the src attribute","type":"string","default":"data-src"},"srcset":{"title":"Attribute used to build the srcset attribute","type":"string","default":"data-srcset"},"sizes":{"title":"Attribute used to build the sizes attribute","type":"string","default":"data-sizes"},"browser":{"title":"Remove the loading lazy attribute","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"class":{"title":"Remove a class name on the class attribute","type":"string","default":"lazyload"},"src":{"title":"Attribute used to build the src attribute","type":"string","default":"data-src"},"srcset":{"title":"Attribute used to build the srcset attribute","type":"string","default":"data-srcset"},"sizes":{"title":"Attribute used to build the sizes attribute","type":"string","default":"data-sizes"},"browser":{"title":"Remove the loading lazy attribute","type":"boolean","default":false}},"additionalProperties":false}}}}}}}}}}}}}}}}},"put":{"summary":"Update Image settings","tags":["Image"],"description":"Optimize your images","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"optimization":{"type":"object","additionalProperties":false,"properties":{"optimize_gif":{"type":"object","title":"compression of GIF images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"compression_rate":{"title":"Lossiness","description":"Lossiness determines how many artifacts are allowed","type":"integer","minimum":30,"maximum":200,"default":50}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"compression_rate":{"title":"Lossiness","description":"Lossiness determines how many artifacts are allowed","type":"integer","minimum":30,"maximum":200,"default":50}},"additionalProperties":false}}}}}}}},"optimize_jpeg":{"type":"object","title":"compression of JPEG images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"progressive":{"title":"Encode image in progressive mode","description":"A progressive JPEG will actually show the entire image right away at low resolution. As loading proceeds, the image becomes sharper.","type":"boolean","default":false},"strip_metadata":{"title":"Strip Metadata","description":"Remove auxiliary information about the image such as thumbnails, copyright information while keeping orientation and color profile","type":"boolean","default":false},"automatic_quality_detection":{"title":"Automatic quality detection","description":"Figure out which quality setting is best for each image based on artifact detection algorithm while keeping perceived visual quality the same","type":"boolean","default":false},"quality":{"type":"integer","title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":80},"automatic_quality_preset":{"type":"string","title":"Automatic quality sensitivity","description":"Give the level of accuracy between the optimized image and the original image","enum":["low","medium","high","veryhigh"],"default":"medium"},"min_automatic_quality":{"type":"integer","title":"Minimum quality level for automatic detection","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":75}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"progressive":{"title":"Encode image in progressive mode","description":"A progressive JPEG will actually show the entire image right away at low resolution. As loading proceeds, the image becomes sharper.","type":"boolean","default":false},"strip_metadata":{"title":"Strip Metadata","description":"Remove auxiliary information about the image such as thumbnails, copyright information while keeping orientation and color profile","type":"boolean","default":false},"automatic_quality_detection":{"title":"Automatic quality detection","description":"Figure out which quality setting is best for each image based on artifact detection algorithm while keeping perceived visual quality the same","type":"boolean","default":false},"quality":{"type":"integer","title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":80},"automatic_quality_preset":{"type":"string","title":"Automatic quality sensitivity","description":"Give the level of accuracy between the optimized image and the original image","enum":["low","medium","high","veryhigh"],"default":"medium"},"min_automatic_quality":{"type":"integer","title":"Minimum quality level for automatic detection","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","minimum":40,"maximum":100,"default":75}},"additionalProperties":false}}}}}}}},"optimize_png":{"type":"object","title":"Lossless compression of PNG images","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_png24_to_png8":{"type":"boolean","title":"convert any PNG-24 image into an alpha PNG-8","description":"The conversion reduces file sizes significantly (often as much as 70%) and preserves full alpha transparency","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_png24_to_png8":{"type":"boolean","title":"convert any PNG-24 image into an alpha PNG-8","description":"The conversion reduces file sizes significantly (often as much as 70%) and preserves full alpha transparency","default":false}},"additionalProperties":false}}}}}}}},"optimize_svg":{"type":"object","title":"compression of SVG images","description":"SVG files, especially those exported from various editors, usually contain a lot of redundant and useless information. This can include editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting the SVG rendering result.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Optimizer version","description":"Two existing version : 1 for the version released in 2017 and 2 for the version released in 2020"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Optimizer version","description":"Two existing version : 1 for the version released in 2017 and 2 for the version released in 2020"}},"additionalProperties":false}}}}}}}},"optimize_webp":{"type":"object","title":"compression of WebP images","description":"WebP is a modern format that replace JPEG and PNG. It is supported by all major browsers","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a WebP copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for WebP","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":80},"alpha_quality":{"title":"Quality of alpha layer","description":"The alpha layer is the layer for the transparency part of the image","type":"integer","minimum":0,"maximum":100,"default":100},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"near_lossless":{"title":"Level of near-lossless image preprocessing","description":"This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically.","type":"boolean","default":false},"smart_subsample":{"title":"Smart Subsampling","description":"Use high quality chroma subsampling","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a WebP copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for WebP","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":80},"alpha_quality":{"title":"Quality of alpha layer","description":"The alpha layer is the layer for the transparency part of the image","type":"integer","minimum":0,"maximum":100,"default":100},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"near_lossless":{"title":"Level of near-lossless image preprocessing","description":"This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically.","type":"boolean","default":false},"smart_subsample":{"title":"Smart Subsampling","description":"Use high quality chroma subsampling","type":"boolean","default":false}}}}}}}}}},"optimize_avif":{"type":"object","title":"compression of AVIF images","description":"New image format derived from the keyframes of AV1 video","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a AVIF copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for AVIF","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":50},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"chroma_subsampling":{"title":"Chroma subsampling","description":"set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling","type":"string","default":"4:2:0","enum":["4:2:0","4:4:4"]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"convert_to_modern_format":{"title":"Generate a AVIF copy of JPEG and PNG images","description":"Image tags are replaced by picture tags with a source for AVIF","type":"boolean","default":true},"quality":{"title":"Quality level","description":"Quality determines the level of lossy compression. The sensitive values are often between 70 to 90","type":"integer","minimum":0,"maximum":100,"default":50},"lossless":{"title":"Encode the image without any loss","type":"boolean","default":false},"chroma_subsampling":{"title":"Chroma subsampling","description":"set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling","type":"string","default":"4:2:0","enum":["4:2:0","4:4:4"]}}}}}}}}}}}},"resize":{"type":"object","title":"Resize images via query parameters","description":"Use query parameters in the image URL to resize it. Parameters are frz-width, frz-height, frz-fit, frz-gravity and frz-enlarge","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"operations":{"type":"object","title":"Image operations","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"sharpen":{"title":"Sharpen the image","type":"boolean","default":false}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"sharpen":{"title":"Sharpen the image","type":"boolean","default":false}}}}}}}}}},"img_dimensions_attr":{"type":"object","title":"Generate width and height for img tag in html","description":"Analyze your images and store their width and height in the img tag to improve CLS","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"img_url_attr":{"type":"object","title":"Extend image optimizations to images in custom HTML tags","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"tags":{"title":"Tags","description":"HTML tags that can have an atttribute containing an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}},"attributes":{"title":"Attributes","description":"HTML tag attributes that can contain an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"tags":{"title":"Tags","description":"HTML tags that can have an atttribute containing an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}},"attributes":{"title":"Attributes","description":"HTML tag attributes that can contain an image URL.","type":"array","default":[],"items":{"type":"string","minLength":1}}}}}}}}}}},"delivery":{"type":"object","additionalProperties":false,"properties":{"lazyload":{"type":"object","title":"Images lazyloading","description":"Deferring loading of images reduce the render time","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"version":{"title":"Version of the lazyload library","description":"The version 2 of the lazyloader supports elements that are dynamically injected in the DOM.","type":"integer","default":1,"enum":[1,2,3]},"offset":{"title":"Number of images to skip","description":"The lazyloader will not be active on the first Nth images.","type":"integer","default":5}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"version":{"title":"Version of the lazyload library","description":"The version 2 of the lazyloader supports elements that are dynamically injected in the DOM.","type":"integer","default":1,"enum":[1,2,3]},"offset":{"title":"Number of images to skip","description":"The lazyloader will not be active on the first Nth images.","type":"integer","default":5}}}}}}}}}},"responsive":{"type":"object","title":"Images responsible","description":"Automatically adjusts the image size to fit the screen.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"offset":{"title":"Number of images to skip","description":"The Responsive will not be active on the first Nth images.","type":"integer","default":5}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"offset":{"title":"Number of images to skip","description":"The Responsive will not be active on the first Nth images.","type":"integer","default":5}}}}}}}}}},"inlining":{"type":"object","title":"Inline the small images directly in the page","description":"It permits to save the request time. It's particularly important for the mobile site.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"unlazyload":{"type":"object","title":"Remove the lazyloader used at the origin","description":"This is useful when the lazyloader is applied on critical images","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"class":{"title":"Remove a class name on the class attribute","type":"string","default":"lazyload"},"src":{"title":"Attribute used to build the src attribute","type":"string","default":"data-src"},"srcset":{"title":"Attribute used to build the srcset attribute","type":"string","default":"data-srcset"},"sizes":{"title":"Attribute used to build the sizes attribute","type":"string","default":"data-sizes"},"browser":{"title":"Remove the loading lazy attribute","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"class":{"title":"Remove a class name on the class attribute","type":"string","default":"lazyload"},"src":{"title":"Attribute used to build the src attribute","type":"string","default":"data-src"},"srcset":{"title":"Attribute used to build the srcset attribute","type":"string","default":"data-srcset"},"sizes":{"title":"Attribute used to build the sizes attribute","type":"string","default":"data-sizes"},"browser":{"title":"Remove the loading lazy attribute","type":"boolean","default":false}},"additionalProperties":false}}}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-image:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/inlinks":{"get":{"summary":"Get Inlinks settings","tags":["Inlinks"],"description":"Detect and fix internal redirected links","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}},"put":{"summary":"Update Inlinks settings","tags":["Inlinks"],"description":"Detect and fix internal redirected links","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/js":{"get":{"summary":"Get Js settings","tags":["Js"],"description":"Optimize your JS files","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-js:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify JavaScript","description":"Compacting JavaScript code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Version of the minificator library","description":"The version 2 of the minificator supports ES6."}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Version of the minificator library","description":"The version 2 of the minificator supports ES6."}},"additionalProperties":false}}}}}}}},"concat":{"type":"object","title":"Combine external JavaScript","description":"Combining external scripts into as few files as possible cuts down on RTTs and delays in downloading other resources.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"defer":{"type":"object","title":"Defer loading of JavaScript","description":"Deferring loading of JavaScript functions that are not called at startup reduces the initial download size, allowing other resources to be downloaded in parallel, and speeding up execution and rendering time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"only_external":{"type":"boolean","default":false,"title":"Limit defer loading to externals domains","description":"Defer loading of JavaScript files will only be applied to files downloaded from externals domains (widgets, tags, ads ...)"},"preload":{"type":"boolean","default":true,"title":"Preload deferred scripts","description":"Add a link rel=preload for deferred scripts. Useful for the smartcache"},"preload_version":{"type":"integer","default":2,"enum":[1,2],"title":"Select preloader version","description":"Version 1 adds a <link rel=preload> directly in the page. Version 2 adds a <link rel=preload> via a script"},"preload_strategy":{"type":"string","default":"<script>(function () { document.head.appendChild(frzScriptsToPreload); })(); </script>","title":"Preload script (only with version 2)","description":"Allow you to customize the preload script. The list of scripts to preload is available via the frzScriptsToPreloadUrls variable"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"only_external":{"type":"boolean","default":false,"title":"Limit defer loading to externals domains","description":"Defer loading of JavaScript files will only be applied to files downloaded from externals domains (widgets, tags, ads ...)"},"preload":{"type":"boolean","default":true,"title":"Preload deferred scripts","description":"Add a link rel=preload for deferred scripts. Useful for the smartcache"},"preload_version":{"type":"integer","default":2,"enum":[1,2],"title":"Select preloader version","description":"Version 1 adds a <link rel=preload> directly in the page. Version 2 adds a <link rel=preload> via a script"},"preload_strategy":{"type":"string","default":"<script>(function () { document.head.appendChild(frzScriptsToPreload); })(); </script>","title":"Preload script (only with version 2)","description":"Allow you to customize the preload script. The list of scripts to preload is available via the frzScriptsToPreloadUrls variable"}},"additionalProperties":false}}}}}}}},"lazyload":{"type":"object","title":"Lazy load JavaScript","description":"Load JavaScript files only when specific elements become visible in the viewport.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"rules":{"type":"array","title":"Lazy loading rules","description":"Define conditions for lazy loading scripts","items":{"type":"object","required":["targetSelector","scriptSelector"],"properties":{"targetSelector":{"type":"string","title":"Target selector","description":"CSS selector for the target element that triggers script loading","minLength":1},"scriptSelector":{"type":"string","title":"Script selector","description":"CSS selector for the script to lazy load","minLength":1},"threshold":{"type":"number","title":"Threshold","description":"Intersection threshold (0 to 1). Default is 0.1","minimum":0,"maximum":1,"default":0.1,"multipleOf":0.01}},"additionalProperties":false},"default":[]}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"rules":{"type":"array","title":"Lazy loading rules","description":"Define conditions for lazy loading scripts","items":{"type":"object","required":["targetSelector","scriptSelector"],"properties":{"targetSelector":{"type":"string","title":"Target selector","description":"CSS selector for the target element that triggers script loading","minLength":1},"scriptSelector":{"type":"string","title":"Script selector","description":"CSS selector for the script to lazy load","minLength":1},"threshold":{"type":"number","title":"Threshold","description":"Intersection threshold (0 to 1). Default is 0.1","minimum":0,"maximum":1,"default":0.1,"multipleOf":0.01}},"additionalProperties":false},"default":[]}},"additionalProperties":false}}}}}}}}}}}}}}},"put":{"summary":"Update Js settings","tags":["Js"],"description":"Optimize your JS files","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"object","title":"Minify JavaScript","description":"Compacting JavaScript code can save many bytes of data and speed up downloading, parsing, and execution time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Version of the minificator library","description":"The version 2 of the minificator supports ES6."}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","default":1,"enum":[1,2],"title":"Version of the minificator library","description":"The version 2 of the minificator supports ES6."}},"additionalProperties":false}}}}}}}},"concat":{"type":"object","title":"Combine external JavaScript","description":"Combining external scripts into as few files as possible cuts down on RTTs and delays in downloading other resources.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"defer":{"type":"object","title":"Defer loading of JavaScript","description":"Deferring loading of JavaScript functions that are not called at startup reduces the initial download size, allowing other resources to be downloaded in parallel, and speeding up execution and rendering time.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"only_external":{"type":"boolean","default":false,"title":"Limit defer loading to externals domains","description":"Defer loading of JavaScript files will only be applied to files downloaded from externals domains (widgets, tags, ads ...)"},"preload":{"type":"boolean","default":true,"title":"Preload deferred scripts","description":"Add a link rel=preload for deferred scripts. Useful for the smartcache"},"preload_version":{"type":"integer","default":2,"enum":[1,2],"title":"Select preloader version","description":"Version 1 adds a <link rel=preload> directly in the page. Version 2 adds a <link rel=preload> via a script"},"preload_strategy":{"type":"string","default":"<script>(function () { document.head.appendChild(frzScriptsToPreload); })(); </script>","title":"Preload script (only with version 2)","description":"Allow you to customize the preload script. The list of scripts to preload is available via the frzScriptsToPreloadUrls variable"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"only_external":{"type":"boolean","default":false,"title":"Limit defer loading to externals domains","description":"Defer loading of JavaScript files will only be applied to files downloaded from externals domains (widgets, tags, ads ...)"},"preload":{"type":"boolean","default":true,"title":"Preload deferred scripts","description":"Add a link rel=preload for deferred scripts. Useful for the smartcache"},"preload_version":{"type":"integer","default":2,"enum":[1,2],"title":"Select preloader version","description":"Version 1 adds a <link rel=preload> directly in the page. Version 2 adds a <link rel=preload> via a script"},"preload_strategy":{"type":"string","default":"<script>(function () { document.head.appendChild(frzScriptsToPreload); })(); </script>","title":"Preload script (only with version 2)","description":"Allow you to customize the preload script. The list of scripts to preload is available via the frzScriptsToPreloadUrls variable"}},"additionalProperties":false}}}}}}}},"lazyload":{"type":"object","title":"Lazy load JavaScript","description":"Load JavaScript files only when specific elements become visible in the viewport.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"rules":{"type":"array","title":"Lazy loading rules","description":"Define conditions for lazy loading scripts","items":{"type":"object","required":["targetSelector","scriptSelector"],"properties":{"targetSelector":{"type":"string","title":"Target selector","description":"CSS selector for the target element that triggers script loading","minLength":1},"scriptSelector":{"type":"string","title":"Script selector","description":"CSS selector for the script to lazy load","minLength":1},"threshold":{"type":"number","title":"Threshold","description":"Intersection threshold (0 to 1). Default is 0.1","minimum":0,"maximum":1,"default":0.1,"multipleOf":0.01}},"additionalProperties":false},"default":[]}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"rules":{"type":"array","title":"Lazy loading rules","description":"Define conditions for lazy loading scripts","items":{"type":"object","required":["targetSelector","scriptSelector"],"properties":{"targetSelector":{"type":"string","title":"Target selector","description":"CSS selector for the target element that triggers script loading","minLength":1},"scriptSelector":{"type":"string","title":"Script selector","description":"CSS selector for the script to lazy load","minLength":1},"threshold":{"type":"number","title":"Threshold","description":"Intersection threshold (0 to 1). Default is 0.1","minimum":0,"maximum":1,"default":0.1,"multipleOf":0.01}},"additionalProperties":false},"default":[]}},"additionalProperties":false}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-js:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/llmstxt":{"get":{"summary":"Get Llmstxt settings","tags":["Llmstxt"],"description":"Manage your llms.txt file","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-llmstxt:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","title":"Manage llms.txt","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","title":"URL containing the content of the llms.txt file or content of the llms.txt","required":["type","content"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["text","uri"]},"content":{"type":"string","default":""}}}}}}}}}}}},"put":{"summary":"Update Llmstxt settings","tags":["Llmstxt"],"description":"Manage your llms.txt file","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Manage llms.txt","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","title":"URL containing the content of the llms.txt file or content of the llms.txt","required":["type","content"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["text","uri"]},"content":{"type":"string","default":""}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-llmstxt:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/network":{"get":{"summary":"Get Network settings","tags":["Network"],"description":"Manage your network settings","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-network:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"title":"Network setting","type":"object","additionalProperties":false,"required":["regions","vhost","deploy_ratio"],"properties":{"regions":{"title":"Fasterize Region","description":"euwest1 is the region of Paris","type":"object","additionalProperties":{"type":"object","required":["enabled"],"additionalProperties":false,"properties":{"enabled":{"type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"ratio":{"title":"Percentile of requests sent to the region at DNS level","type":"integer","default":100,"minimum":0,"maximum":100}}}}}},"vhost":{"title":"Vhost generation","description":"This vhost is required for the TLS termination and is generated only for the primary domain","type":"object","required":["enabled"],"additionalProperties":false,"properties":{"enabled":{"type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"extra_nginx_location":{"title":"extra Nginx location","type":"string"},"preserve_x_forwarded_for":{"title":"Keep X-Forwarded-For header from client request","description":"By default, Fasterize rewrite the X-Forwarded-For header to remove all proxy IPs and keep only the browser IP. This is done to simplify the header parsing at the origin.","type":"boolean","default":false},"trusted_proxies_chain":{"title":"Trusted Proxies Chain","type":"array","description":"An ordered list of trusted proxies (CDN/WAF) in front of the platform. The first element represents the edge proxy closest to the client.","items":{"type":"string","enum":["cloudflare","cloudfront","imperva","fastly","bunny","akamai","cdnetworks"],"description":"The name of a CDN/WAF in the chain."},"uniqueItems":true,"maxItems":2,"default":[]},"validate_trusted_proxies":{"title":"Validate Trusted Proxies","description":"Indicates whether to validate the trusted proxies when determining the client IP for filtering.","type":"boolean","default":false},"block_untrusted_proxies":{"title":"Block Untrusted Proxies","description":"Indicates whether to block traffic originating from untrusted sources.","type":"boolean","default":false},"client_ip_blacklist_only_proxy":{"title":"If true vhost will not block blacklist IP","type":"boolean","default":false}}}}},"deploy_ratio":{"title":"Percentile of requests sent to Fasterize at the DNS level","type":"integer","minimum":0,"maximum":100,"default":0},"sharding":{"type":"object","title":"Parallelize downloads across hostnames without cookie","description":"HTTP/1.1 only : serve resources from several different hostnames to increases parallelization of downloads.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"in_style_attribute":{"title":"Shard in the style attribute","description":"The style attribute is parsed to shard the url of the background images.","type":"boolean","default":false},"preserve_robot_txt":{"title":"Use the same robots.txt for the sharding domain than the original domain","description":"This option is set to false by default to use a custom robots.txt allowing indexation only on assets for sharding domain","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"in_style_attribute":{"title":"Shard in the style attribute","description":"The style attribute is parsed to shard the url of the background images.","type":"boolean","default":false},"preserve_robot_txt":{"title":"Use the same robots.txt for the sharding domain than the original domain","description":"This option is set to false by default to use a custom robots.txt allowing indexation only on assets for sharding domain","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"ipv6":{"title":"IPv6","description":"Whether the IPv6 is enabled for the distribution","type":"boolean","default":false},"http3":{"title":"HTTP3","description":"Whether HTTP3 is enabled for the distribution","type":"boolean","default":false}}}}}}}},"put":{"summary":"Update Network settings","tags":["Network"],"description":"Manage your network settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Network setting","type":"object","additionalProperties":false,"required":["regions","vhost","deploy_ratio"],"properties":{"regions":{"title":"Fasterize Region","description":"euwest1 is the region of Paris","type":"object","additionalProperties":{"type":"object","required":["enabled"],"additionalProperties":false,"properties":{"enabled":{"type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"ratio":{"title":"Percentile of requests sent to the region at DNS level","type":"integer","default":100,"minimum":0,"maximum":100}}}}}},"vhost":{"title":"Vhost generation","description":"This vhost is required for the TLS termination and is generated only for the primary domain","type":"object","required":["enabled"],"additionalProperties":false,"properties":{"enabled":{"type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"extra_nginx_location":{"title":"extra Nginx location","type":"string"},"preserve_x_forwarded_for":{"title":"Keep X-Forwarded-For header from client request","description":"By default, Fasterize rewrite the X-Forwarded-For header to remove all proxy IPs and keep only the browser IP. This is done to simplify the header parsing at the origin.","type":"boolean","default":false},"trusted_proxies_chain":{"title":"Trusted Proxies Chain","type":"array","description":"An ordered list of trusted proxies (CDN/WAF) in front of the platform. The first element represents the edge proxy closest to the client.","items":{"type":"string","enum":["cloudflare","cloudfront","imperva","fastly","bunny","akamai","cdnetworks"],"description":"The name of a CDN/WAF in the chain."},"uniqueItems":true,"maxItems":2,"default":[]},"validate_trusted_proxies":{"title":"Validate Trusted Proxies","description":"Indicates whether to validate the trusted proxies when determining the client IP for filtering.","type":"boolean","default":false},"block_untrusted_proxies":{"title":"Block Untrusted Proxies","description":"Indicates whether to block traffic originating from untrusted sources.","type":"boolean","default":false},"client_ip_blacklist_only_proxy":{"title":"If true vhost will not block blacklist IP","type":"boolean","default":false}}}}},"deploy_ratio":{"title":"Percentile of requests sent to Fasterize at the DNS level","type":"integer","minimum":0,"maximum":100,"default":0},"sharding":{"type":"object","title":"Parallelize downloads across hostnames without cookie","description":"HTTP/1.1 only : serve resources from several different hostnames to increases parallelization of downloads.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"in_style_attribute":{"title":"Shard in the style attribute","description":"The style attribute is parsed to shard the url of the background images.","type":"boolean","default":false},"preserve_robot_txt":{"title":"Use the same robots.txt for the sharding domain than the original domain","description":"This option is set to false by default to use a custom robots.txt allowing indexation only on assets for sharding domain","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"in_style_attribute":{"title":"Shard in the style attribute","description":"The style attribute is parsed to shard the url of the background images.","type":"boolean","default":false},"preserve_robot_txt":{"title":"Use the same robots.txt for the sharding domain than the original domain","description":"This option is set to false by default to use a custom robots.txt allowing indexation only on assets for sharding domain","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"ipv6":{"title":"IPv6","description":"Whether the IPv6 is enabled for the distribution","type":"boolean","default":false},"http3":{"title":"HTTP3","description":"Whether HTTP3 is enabled for the distribution","type":"boolean","default":false}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-network:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/page-cache":{"get":{"summary":"Get Full Page Caching settings","tags":["Full Page Caching"],"description":"Manage your page cache","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-page-cache:read"]}],"responses":{"200":{"description":"This section contains cache segmentation and cache-control settings","content":{"application/json":{"schema":{"title":"Cache section","description":"This section contains cache segmentation and cache-control settings","type":"object","additionalProperties":false,"properties":{"segmentation":{"title":"Cache segmentation","description":"Partition cache in different slot and perform adaptive serving","type":"object","additionalProperties":false,"properties":{"user_agent_classification":{"type":"string","title":"Classified user agent as \"desktop recent\", \"mobile\", \"tablet\", \"bot\" or \"old\". bot_first value considers mobile bot as bot instead of mobile. ie11_old classifies Internet Explorer 11 as old. Responsive value considers only two cache keys: desktop_recent or bot","enum":["default","bot_first","ie11_old","responsive"],"default":"responsive"},"custom_key":{"type":"object","title":"Custom cookie in the cache key","description":"This replace the cookie fstrz_vary used by Fasterize","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cookie_name":{"type":"string","default":""}}}}}}},"default_variation":{"title":"Default cache key","description":"Set a default cache key when no cookie is present. Functionality only works when the configuration is plugged","type":"string"},"variation_script":{"type":"object","title":"Cache key computed in Javascript ","description":"Fasterize can cache different versions of the same page (same URL). The most common variations are based on the device, country, language or devise of the user. Technically, Fasterize builds a cache key by looking at a cookie computed by a script executed on the page.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Script that computes the variation","description":"The script must call the method setCacheKey. For instance, setCacheKey('FR');. It is called on every page.","type":"string"},"possible_variations":{"title":"Possible variations","description":"Specified variations that will be considered for cache flush","type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"default_variation":{"title":"Default cache key","description":"Set a default cache key when no cookie is present. Functionality only works when the configuration is plugged","type":"string"}}}}}}},"anonymous_page_caching":{"type":"object","title":"Serve a page from the cache until the user receives cookies","description":"This permits to cache dynamic pages when the page varies only when the user performs actions such as adding an item to their cart or logging in","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ttl":{"title":"Time to live - duration of the page in cache","type":"integer","default":21600}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ttl":{"title":"Time to live - duration of the page in cache","type":"integer","default":21600}}}}}}}}}}}},"policies":{"type":"object","title":"Smartcache - full page caching","description":"The static elements are cached, while the dynamic elements are automatically loaded via JSONP afterwards. The full page is reconstructed in the browser.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":false},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":false},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":86400},"stale_while_revalidate_ttl":{"title":"Cache TTL for Stale-While-Revalidate (if CDN caching is enabled)","description":"Serves a stale cached version of the page while a new version is fetched from the origin. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-while-revalidate=X).","type":"integer","minimum":0},"stale_if_error_ttl":{"title":"Cache TTL for Stale-If-Error (if CDN caching is enabled)","description":"Serves a cached version of the page if the origin server returns a 5xx error. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-if-error=X).","type":"integer","minimum":0},"css_selectors":{"title":"Fragments filtered by CSS Selectors","description":"Select the private part of the page for each session: cart, account, last seen product, CSRF token.","type":"array","items":{"type":"string","minLength":1},"default":[]},"fragments":{"title":"Fragments","description":"List of fragments","type":"array","items":{"type":"object","required":["css_selector"],"additionalProperties":false,"properties":{"css_selector":{"title":"CSS selector","description":"CSS selector to select the fragment","type":"string","minLength":1},"keep_original_content":{"title":"Preserve original content","description":"If true, the existing fragment content is not cleared. Use it to avoid CLS shifts. Be careful, sensitive data may be cached.","type":"boolean"},"placeholder":{"title":"Placeholder HTML","description":"HTML placeholder to inject in place of the fragment content.","type":"string","minLength":1},"id_definition":{"title":"ID definition for fragment identification","description":"Configuration to define how to identify fragments with unique IDs","type":"object","required":["attribute","closest_css_selector","prefix"],"additionalProperties":false,"properties":{"attribute":{"title":"Attribute containing the ID value","description":"Specifies the attribute that contains the value used as ID","type":"string"},"closest_css_selector":{"title":"Closest CSS selector for ID context","description":"CSS selector to find the closest element containing the ID in the attribute defined in attribute property","type":"string"},"prefix":{"title":"Prefix for the ID","description":"Allows handling cases where two fragment selectors may match the same element for fragment id definition","type":"string","minLength":1,"maxLength":50},"maximum_up_depth":{"title":"Maximum up depth","description":"Maximum up depth to find the closest element defined in closest_css_selector. Default is 20.","type":"number"}}}}},"default":[]},"fragment_loading":{"title":"Loading strategy used by fragment script","description":"async value is faster. defer value is safer","type":"string","default":"async","enum":["async","defer"]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":false},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":false},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":86400},"stale_while_revalidate_ttl":{"title":"Cache TTL for Stale-While-Revalidate (if CDN caching is enabled)","description":"Serves a stale cached version of the page while a new version is fetched from the origin. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-while-revalidate=X).","type":"integer","minimum":0},"stale_if_error_ttl":{"title":"Cache TTL for Stale-If-Error (if CDN caching is enabled)","description":"Serves a cached version of the page if the origin server returns a 5xx error. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-if-error=X).","type":"integer","minimum":0},"css_selectors":{"title":"Fragments filtered by CSS Selectors","description":"Select the private part of the page for each session: cart, account, last seen product, CSRF token.","type":"array","items":{"type":"string","minLength":1},"default":[]},"fragments":{"title":"Fragments","description":"List of fragments","type":"array","items":{"type":"object","required":["css_selector"],"additionalProperties":false,"properties":{"css_selector":{"title":"CSS selector","description":"CSS selector to select the fragment","type":"string","minLength":1},"keep_original_content":{"title":"Preserve original content","description":"If true, the existing fragment content is not cleared. Use it to avoid CLS shifts. Be careful, sensitive data may be cached.","type":"boolean"},"placeholder":{"title":"Placeholder HTML","description":"HTML placeholder to inject in place of the fragment content.","type":"string","minLength":1},"id_definition":{"title":"ID definition for fragment identification","description":"Configuration to define how to identify fragments with unique IDs","type":"object","required":["attribute","closest_css_selector","prefix"],"additionalProperties":false,"properties":{"attribute":{"title":"Attribute containing the ID value","description":"Specifies the attribute that contains the value used as ID","type":"string"},"closest_css_selector":{"title":"Closest CSS selector for ID context","description":"CSS selector to find the closest element containing the ID in the attribute defined in attribute property","type":"string"},"prefix":{"title":"Prefix for the ID","description":"Allows handling cases where two fragment selectors may match the same element for fragment id definition","type":"string","minLength":1,"maxLength":50},"maximum_up_depth":{"title":"Maximum up depth","description":"Maximum up depth to find the closest element defined in closest_css_selector. Default is 20.","type":"number"}}}}},"default":[]},"fragment_loading":{"title":"Loading strategy used by fragment script","description":"async value is faster. defer value is safer","type":"string","default":"async","enum":["async","defer"]}}}}}}}}}}}}}}}}},"put":{"summary":"Update Full Page Caching settings","tags":["Full Page Caching"],"description":"Manage your page cache","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Cache section","description":"This section contains cache segmentation and cache-control settings","type":"object","additionalProperties":false,"properties":{"segmentation":{"title":"Cache segmentation","description":"Partition cache in different slot and perform adaptive serving","type":"object","additionalProperties":false,"properties":{"user_agent_classification":{"type":"string","title":"Classified user agent as \"desktop recent\", \"mobile\", \"tablet\", \"bot\" or \"old\". bot_first value considers mobile bot as bot instead of mobile. ie11_old classifies Internet Explorer 11 as old. Responsive value considers only two cache keys: desktop_recent or bot","enum":["default","bot_first","ie11_old","responsive"],"default":"responsive"},"custom_key":{"type":"object","title":"Custom cookie in the cache key","description":"This replace the cookie fstrz_vary used by Fasterize","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cookie_name":{"type":"string","default":""}}}}}}},"default_variation":{"title":"Default cache key","description":"Set a default cache key when no cookie is present. Functionality only works when the configuration is plugged","type":"string"},"variation_script":{"type":"object","title":"Cache key computed in Javascript ","description":"Fasterize can cache different versions of the same page (same URL). The most common variations are based on the device, country, language or devise of the user. Technically, Fasterize builds a cache key by looking at a cookie computed by a script executed on the page.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"script":{"title":"Script that computes the variation","description":"The script must call the method setCacheKey. For instance, setCacheKey('FR');. It is called on every page.","type":"string"},"possible_variations":{"title":"Possible variations","description":"Specified variations that will be considered for cache flush","type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"default_variation":{"title":"Default cache key","description":"Set a default cache key when no cookie is present. Functionality only works when the configuration is plugged","type":"string"}}}}}}},"anonymous_page_caching":{"type":"object","title":"Serve a page from the cache until the user receives cookies","description":"This permits to cache dynamic pages when the page varies only when the user performs actions such as adding an item to their cart or logging in","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ttl":{"title":"Time to live - duration of the page in cache","type":"integer","default":21600}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"ttl":{"title":"Time to live - duration of the page in cache","type":"integer","default":21600}}}}}}}}}}}},"policies":{"type":"object","title":"Smartcache - full page caching","description":"The static elements are cached, while the dynamic elements are automatically loaded via JSONP afterwards. The full page is reconstructed in the browser.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":false},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":false},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":86400},"stale_while_revalidate_ttl":{"title":"Cache TTL for Stale-While-Revalidate (if CDN caching is enabled)","description":"Serves a stale cached version of the page while a new version is fetched from the origin. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-while-revalidate=X).","type":"integer","minimum":0},"stale_if_error_ttl":{"title":"Cache TTL for Stale-If-Error (if CDN caching is enabled)","description":"Serves a cached version of the page if the origin server returns a 5xx error. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-if-error=X).","type":"integer","minimum":0},"css_selectors":{"title":"Fragments filtered by CSS Selectors","description":"Select the private part of the page for each session: cart, account, last seen product, CSRF token.","type":"array","items":{"type":"string","minLength":1},"default":[]},"fragments":{"title":"Fragments","description":"List of fragments","type":"array","items":{"type":"object","required":["css_selector"],"additionalProperties":false,"properties":{"css_selector":{"title":"CSS selector","description":"CSS selector to select the fragment","type":"string","minLength":1},"keep_original_content":{"title":"Preserve original content","description":"If true, the existing fragment content is not cleared. Use it to avoid CLS shifts. Be careful, sensitive data may be cached.","type":"boolean"},"placeholder":{"title":"Placeholder HTML","description":"HTML placeholder to inject in place of the fragment content.","type":"string","minLength":1},"id_definition":{"title":"ID definition for fragment identification","description":"Configuration to define how to identify fragments with unique IDs","type":"object","required":["attribute","closest_css_selector","prefix"],"additionalProperties":false,"properties":{"attribute":{"title":"Attribute containing the ID value","description":"Specifies the attribute that contains the value used as ID","type":"string"},"closest_css_selector":{"title":"Closest CSS selector for ID context","description":"CSS selector to find the closest element containing the ID in the attribute defined in attribute property","type":"string"},"prefix":{"title":"Prefix for the ID","description":"Allows handling cases where two fragment selectors may match the same element for fragment id definition","type":"string","minLength":1,"maxLength":50},"maximum_up_depth":{"title":"Maximum up depth","description":"Maximum up depth to find the closest element defined in closest_css_selector. Default is 20.","type":"number"}}}}},"default":[]},"fragment_loading":{"title":"Loading strategy used by fragment script","description":"async value is faster. defer value is safer","type":"string","default":"async","enum":["async","defer"]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":false},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":false},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":86400},"stale_while_revalidate_ttl":{"title":"Cache TTL for Stale-While-Revalidate (if CDN caching is enabled)","description":"Serves a stale cached version of the page while a new version is fetched from the origin. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-while-revalidate=X).","type":"integer","minimum":0},"stale_if_error_ttl":{"title":"Cache TTL for Stale-If-Error (if CDN caching is enabled)","description":"Serves a cached version of the page if the origin server returns a 5xx error. A value of 0 disables this behavior, while other values define the TTL in seconds (Cache-Control: stale-if-error=X).","type":"integer","minimum":0},"css_selectors":{"title":"Fragments filtered by CSS Selectors","description":"Select the private part of the page for each session: cart, account, last seen product, CSRF token.","type":"array","items":{"type":"string","minLength":1},"default":[]},"fragments":{"title":"Fragments","description":"List of fragments","type":"array","items":{"type":"object","required":["css_selector"],"additionalProperties":false,"properties":{"css_selector":{"title":"CSS selector","description":"CSS selector to select the fragment","type":"string","minLength":1},"keep_original_content":{"title":"Preserve original content","description":"If true, the existing fragment content is not cleared. Use it to avoid CLS shifts. Be careful, sensitive data may be cached.","type":"boolean"},"placeholder":{"title":"Placeholder HTML","description":"HTML placeholder to inject in place of the fragment content.","type":"string","minLength":1},"id_definition":{"title":"ID definition for fragment identification","description":"Configuration to define how to identify fragments with unique IDs","type":"object","required":["attribute","closest_css_selector","prefix"],"additionalProperties":false,"properties":{"attribute":{"title":"Attribute containing the ID value","description":"Specifies the attribute that contains the value used as ID","type":"string"},"closest_css_selector":{"title":"Closest CSS selector for ID context","description":"CSS selector to find the closest element containing the ID in the attribute defined in attribute property","type":"string"},"prefix":{"title":"Prefix for the ID","description":"Allows handling cases where two fragment selectors may match the same element for fragment id definition","type":"string","minLength":1,"maxLength":50},"maximum_up_depth":{"title":"Maximum up depth","description":"Maximum up depth to find the closest element defined in closest_css_selector. Default is 20.","type":"number"}}}}},"default":[]},"fragment_loading":{"title":"Loading strategy used by fragment script","description":"async value is faster. defer value is safer","type":"string","default":"async","enum":["async","defer"]}}}}}}}}}}}}}},"description":"This section contains cache segmentation and cache-control settings"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-page-cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/preload":{"get":{"summary":"Get Preload settings","tags":["Preload"],"description":"Manage resource loading","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-preload:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"early_hints":{"type":"object","title":"Preload critical assets","description":"request the critical resources ahead of time that may be discovered late by the browser","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"script":{"title":"Javascript","description":"Preload javascript","type":"boolean","default":false},"style":{"title":"CSS","description":"Preload CSS","type":"boolean","default":false},"image":{"title":"Images","description":"Preload images","type":"boolean","default":false},"font":{"title":"Fonts","description":"Preload fonts","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"script":{"title":"Javascript","description":"Preload javascript","type":"boolean","default":false},"style":{"title":"CSS","description":"Preload CSS","type":"boolean","default":false},"image":{"title":"Images","description":"Preload images","type":"boolean","default":false},"font":{"title":"Fonts","description":"Preload fonts","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"quick_link":{"type":"object","title":"Quicklink","description":"Prerender next page when user hover a link in the page.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"speculation_rules":{"type":"object","title":"Speculation rules","description":"Add a speculation rules script","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_script":{"title":"Insert Script","description":"Insert the script in the html page","type":"boolean","default":true},"custom_script":{"title":"Custom script","description":"Override Content of the speculation rules script tag","type":"string","pattern":"^[^<]*$","validateJsonString":{"type":"object","properties":{"prerender":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prerender_until_script":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prefetch":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"tag":{"type":"string"}},"additionalProperties":false}},"prerender_only_from_cache":{"title":"Prerender only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true},"prefetch_only_from_cache":{"title":"Prefetch only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_script":{"title":"Insert Script","description":"Insert the script in the html page","type":"boolean","default":true},"custom_script":{"title":"Custom script","description":"Override Content of the speculation rules script tag","type":"string","pattern":"^[^<]*$","validateJsonString":{"type":"object","properties":{"prerender":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prerender_until_script":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prefetch":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"tag":{"type":"string"}},"additionalProperties":false}},"prerender_only_from_cache":{"title":"Prerender only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true},"prefetch_only_from_cache":{"title":"Prefetch only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true}},"additionalProperties":false}}}}}}}},"image_lcp":{"type":"object","title":"Image LCP","description":"Select candidate LCP images to be preloaded early.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"maximum_preload":{"title":"Maximum Preload","description":"Maximum number of LCP image candidates to preload. Picture tag may generate several links but will count for one.","type":"integer","minimum":1,"maximum":20,"default":1},"preload_candidates":{"title":"Preload candidates","type":"array","description":"Unordered list of LCP image candidates to preload. The first img element that match one selector will be used to create the link preload in the limit of maximum_preload.","items":{"type":"object","additionalProperties":false,"required":["css_selector"],"properties":{"css_selector":{"title":"CSS Selector","type":"string","description":"CSS selector matching the image element to preload."},"media_query":{"title":"Media Query","type":"string","description":"Optional media query to conditionally apply the candidate (e.g. (min-width: 768px)).","default":""}}},"default":[]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"maximum_preload":{"title":"Maximum Preload","description":"Maximum number of LCP image candidates to preload. Picture tag may generate several links but will count for one.","type":"integer","minimum":1,"maximum":20,"default":1},"preload_candidates":{"title":"Preload candidates","type":"array","description":"Unordered list of LCP image candidates to preload. The first img element that match one selector will be used to create the link preload in the limit of maximum_preload.","items":{"type":"object","additionalProperties":false,"required":["css_selector"],"properties":{"css_selector":{"title":"CSS Selector","type":"string","description":"CSS selector matching the image element to preload."},"media_query":{"title":"Media Query","type":"string","description":"Optional media query to conditionally apply the candidate (e.g. (min-width: 768px)).","default":""}}},"default":[]}}}}}}}}}}}}}}}}},"put":{"summary":"Update Preload settings","tags":["Preload"],"description":"Manage resource loading","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"early_hints":{"type":"object","title":"Preload critical assets","description":"request the critical resources ahead of time that may be discovered late by the browser","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"script":{"title":"Javascript","description":"Preload javascript","type":"boolean","default":false},"style":{"title":"CSS","description":"Preload CSS","type":"boolean","default":false},"image":{"title":"Images","description":"Preload images","type":"boolean","default":false},"font":{"title":"Fonts","description":"Preload fonts","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"script":{"title":"Javascript","description":"Preload javascript","type":"boolean","default":false},"style":{"title":"CSS","description":"Preload CSS","type":"boolean","default":false},"image":{"title":"Images","description":"Preload images","type":"boolean","default":false},"font":{"title":"Fonts","description":"Preload fonts","type":"boolean","default":false}},"additionalProperties":false}}}}}}}},"quick_link":{"type":"object","title":"Quicklink","description":"Prerender next page when user hover a link in the page.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}},"speculation_rules":{"type":"object","title":"Speculation rules","description":"Add a speculation rules script","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_script":{"title":"Insert Script","description":"Insert the script in the html page","type":"boolean","default":true},"custom_script":{"title":"Custom script","description":"Override Content of the speculation rules script tag","type":"string","pattern":"^[^<]*$","validateJsonString":{"type":"object","properties":{"prerender":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prerender_until_script":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prefetch":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"tag":{"type":"string"}},"additionalProperties":false}},"prerender_only_from_cache":{"title":"Prerender only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true},"prefetch_only_from_cache":{"title":"Prefetch only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"insert_script":{"title":"Insert Script","description":"Insert the script in the html page","type":"boolean","default":true},"custom_script":{"title":"Custom script","description":"Override Content of the speculation rules script tag","type":"string","pattern":"^[^<]*$","validateJsonString":{"type":"object","properties":{"prerender":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prerender_until_script":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"prefetch":{"type":"array","minItems":1,"items":{"type":"object","properties":{"source":{"type":"string","enum":["document","list"]},"urls":{"type":"array","items":{"type":"string","format":"uri"}},"where":{"$ref":"#/components/schemas/def-0"},"eagerness":{"type":"string","enum":["immediate","eager","moderate","conservative"]},"referrer_policy":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}},"relative_to":{"type":"string","enum":["document","ruleset"]},"expects_no_vary_search":{"type":"string"}},"additionalProperties":false}},"tag":{"type":"string"}},"additionalProperties":false}},"prerender_only_from_cache":{"title":"Prerender only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true},"prefetch_only_from_cache":{"title":"Prefetch only from cache","description":"Respond with a 543 if the page is not in the cache","type":"boolean","default":true}},"additionalProperties":false}}}}}}}},"image_lcp":{"type":"object","title":"Image LCP","description":"Select candidate LCP images to be preloaded early.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"maximum_preload":{"title":"Maximum Preload","description":"Maximum number of LCP image candidates to preload. Picture tag may generate several links but will count for one.","type":"integer","minimum":1,"maximum":20,"default":1},"preload_candidates":{"title":"Preload candidates","type":"array","description":"Unordered list of LCP image candidates to preload. The first img element that match one selector will be used to create the link preload in the limit of maximum_preload.","items":{"type":"object","additionalProperties":false,"required":["css_selector"],"properties":{"css_selector":{"title":"CSS Selector","type":"string","description":"CSS selector matching the image element to preload."},"media_query":{"title":"Media Query","type":"string","description":"Optional media query to conditionally apply the candidate (e.g. (min-width: 768px)).","default":""}}},"default":[]}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"maximum_preload":{"title":"Maximum Preload","description":"Maximum number of LCP image candidates to preload. Picture tag may generate several links but will count for one.","type":"integer","minimum":1,"maximum":20,"default":1},"preload_candidates":{"title":"Preload candidates","type":"array","description":"Unordered list of LCP image candidates to preload. The first img element that match one selector will be used to create the link preload in the limit of maximum_preload.","items":{"type":"object","additionalProperties":false,"required":["css_selector"],"properties":{"css_selector":{"title":"CSS Selector","type":"string","description":"CSS selector matching the image element to preload."},"media_query":{"title":"Media Query","type":"string","description":"Optional media query to conditionally apply the candidate (e.g. (min-width: 768px)).","default":""}}},"default":[]}}}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-preload:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/robotstxt":{"get":{"summary":"Get Robotstxt settings","tags":["Robotstxt"],"description":"Manage your robots.txt file","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-robotstxt:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","title":"Manage robots.txt","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","title":"URL containing the content of the robots.txt file or content of the robots.txt","required":["type","content"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["text","uri"]},"content":{"type":"string","default":""}}}}}}}}}}}},"put":{"summary":"Update Robotstxt settings","tags":["Robotstxt"],"description":"Manage your robots.txt file","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Manage robots.txt","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","title":"URL containing the content of the robots.txt file or content of the robots.txt","required":["type","content"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["text","uri"]},"content":{"type":"string","default":""}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-robotstxt:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/seo-metadata":{"get":{"summary":"Get SEO Metadata settings","tags":["SEO Metadata"],"description":"Assess the metadata health of your pages","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}}}},"put":{"summary":"Update SEO Metadata settings","tags":["SEO Metadata"],"description":"Assess the metadata health of your pages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-metadata:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/seo-recommendation":{"get":{"summary":"Get Seo Recommendation settings","tags":["Seo Recommendation"],"description":"Deploy your SEO recommendations","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-recommendation:read"]}],"responses":{"200":{"description":"The seo recommendations allows you to easily set up advanced SEO recipes on target","content":{"application/json":{"schema":{"type":"object","title":"SEO Recommendations","description":"The seo recommendations allows you to easily set up advanced SEO recipes on target","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"recommendations":{"type":"array","items":{"type":"object","required":["name","recipes","datasets"],"oneOf":[{"type":"object","required":["target"]},{"type":"object","required":["target_ref"]}],"additionalProperties":false,"properties":{"uuid":{"type":"string","format":"uuid","title":"UUID","description":"Unique identifier for the recommendation (UUID). Generated by the database when creating a new recommendation"},"name":{"type":"string","title":"Recommendation name","description":"Name of the recommendation"},"description":{"type":"string","title":"Recommendation description","description":"Description of the recommendation","default":""},"app":{"type":"string","title":"Managing app","description":"Marks the recommendation as managed by a specific app. Hidden from the SEO Recommendations UI when set."},"example_url":{"type":"string","title":"Example Url","description":"An example url on which the recommendation will be applied. (For testing purposes)"},"scheduledFrom":{"type":"string","format":"date-time","title":"Scheduled enable time","description":"ISO 8601 UTC datetime at which the recommendation will be automatically enabled"},"scheduledTo":{"type":"string","format":"date-time","title":"Scheduled disable time","description":"ISO 8601 UTC datetime at which the recommendation will be automatically disabled"},"enabled":{"type":"boolean","title":"Enable","default":true},"csr":{"type":"boolean","default":false,"description":"Recommendation will be reinjected on the page if change is detected"},"target_ref":{"type":"string","minLength":1,"title":"Target reference","description":"ID of a registry target whose context targets this recommendation"},"target":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"datasets":{"type":"array","maxItems":10,"default":[],"items":{"type":"object","required":["id","key"],"properties":{"id":{"title":"ID","description":"Datastorage dataset id to use for this recommendation","type":"string","pattern":"^[A-Z_]+$","example":"METADATAS"},"key":{"anyOf":[{"type":"string","title":"Use URL as key","description":"Use the URL as key to retrieve the value from the dataset","enum":["REQ_URL"]},{"type":"string","title":"Key","description":"The key to the value from the dataset","minLength":1}]},"spread":{"type":"boolean","title":"Spread the values at the variables context root","description":"If the value is an object it will be merged with the variables context. If a variable has the same name as a key in the object, the value from the dataset will be used at the key in resulting context."},"alias":{"type":"string","pattern":"^[a-zA-Z0-9_]+$","title":"Value alias at the variables context root","description":"Makes the value accessible at the given key name","minLength":1,"maxLength":100}}}},"variables":{"type":"object","title":"User defined variables usable in this recommendation","description":"Define variables that can be used in the recipes","default":{},"additionalProperties":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"extraction":{"type":"string","enum":["text","html","attribute"]},"attribute":{"type":"string","minLength":1,"maxLength":500},"value":{"type":"string","maxLength":5000,"minLength":1},"select_all":{"description":"Turns the variable into an array with the values from all matches","type":"boolean"},"select_nth":{"description":"Select the nth element matched by the css selector from the start of the list (first element = 1)","type":"integer","minimum":1,"maximum":9007199254740991},"select_nth_from_last":{"description":"Select the nth element matched by the css selector from the end of the list (last element = 1)","type":"integer","minimum":1,"maximum":9007199254740991},"secret":{"description":"Marks the variable as a secret value","type":"boolean"},"source_key":{"type":"string","minLength":1,"maxLength":100}},"if":{"oneOf":[{"required":["value"]},{"required":["secret","source_key"],"properties":{"secret":{"enum":[true]}}}]},"then":{"properties":{"value":{},"secret":{},"source_key":{}},"additionalProperties":false},"else":{"required":["css_selector","extraction"],"allOf":[{"if":{"properties":{"extraction":{"enum":["attribute"]}}},"then":{"required":["attribute"]}},{"if":{"required":["select_all"],"properties":{"select_all":{"enum":[true]}}},"then":{"not":{"required":["select_nth","select_nth_from_last"]}},"else":{"if":{"required":["select_nth"]},"then":{"not":{"required":["select_nth_from_last"]}},"else":{"required":["select_nth_from_last"]}}}]}}},"recipes":{"type":"array","minItems":1,"items":{"oneOf":[{"type":"object","title":"Upsert <title> tag","description":"Update or insert the title tag in the HTML content (head section)","required":["key","title"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-title-tag"]},"title":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <meta name=\"description\"> tag","description":"Update or insert the meta description tag in the HTML content (head section)","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-meta-description-tag"]},"content":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <link rel=\"canonical\"> tag","description":"Update or insert the canonical link tag in the HTML content (head section). The does not modify HTTP header Link","required":["key","href"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-canonical-link-tag"]},"href":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <meta name=\"robots\"> tag","description":"Update or insert the meta \"robots\" tag in the HTML content (head section).","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-meta-robots-tag"]},"content":{"type":"array","minItems":1,"items":{"type":"string","enum":["all","index","noindex","follow","nofollow","none","noarchive","nositelinkssearchbox","indexifembedded","nosnippet","notranslate","noimageindex"]},"uniqueItems":true},"overwriteHeader":{"type":"boolean","title":"Overwrite X-Robots-Tag header","description":"If true, also sets the X-Robots-Tag HTTP response header with the same content as the meta tag."}}},{"type":"object","title":"Update heading tag","description":"Update <h1>,<h2>,<h3>,<h4>,<h5> or <h6> tags","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["update-heading-tag"]},"replacements":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["css_selector","text"],"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"text":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Upsert <link hreflang=\"\"> tags","description":"Update or insert the \"hreflang\" property of a <link> tag.","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-hreflang-link-tag"]},"replacements":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["url","hreflang"],"properties":{"url":{"type":"string","minLength":1},"hreflang":{"type":"string","description":"format is ISO lang code or x-default","pattern":"^([a-z]{2}(-[A-Z]{2})?|x-default)$"}}}}}},{"type":"object","title":"Add SEO text or internal net linking","required":["key","modifications"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["add-seo-content"]},"modifications":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"operations":{"title":"Possible operations on HTML tags","type":"array","minItems":1,"items":{"type":"object","required":["action","html_content"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside"]},"html_content":{"type":"string","minLength":1}}}}}}}}},{"type":"object","title":"Switch tags name via a CSS selector but keep attributes","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["replace-tag-name"]},"replacements":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"new_tag_name":{"type":"string","title":"New tag name","minLength":1}}}}}},{"type":"object","title":"Hide links tag","description":"replace anchor tag by a span tag","required":["key","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["hide-links"]},"css_selectors":{"title":"CSS Selectors","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","title":"CSS Selectors","minLength":1}}}},{"type":"object","title":"Insert or replace JSON-LD script tag","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-schema-org-tag"]},"content":{"type":"string"}}},{"type":"object","title":"Insert or replace Open Graph tags","required":["key","tags"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-open-graph-tag"]},"tags":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","content"],"properties":{"name":{"type":"string","pattern":"^og:[a-z_:]+$"},"content":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Insert or replace Twitter Card tags","required":["key","tags"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-twitter-card-tag"]},"tags":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","content"],"properties":{"name":{"type":"string","pattern":"^twitter:[a-z:]+$"},"content":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Remove a tag via css selector","required":["key","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["remove-tags"]},"css_selectors":{"type":"array","minItems":1,"items":{"type":"string","title":"CSS Selectors","minLength":1},"uniqueItems":true}}},{"type":"object","title":"Edge Rewriter via CSS selector","required":["key","script","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["edge-rewriter"]},"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string"},"version":{"type":"integer","enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"}}}},{"type":"object","title":"Html to Markdown","description":"Transform html files to markdown for AI bots","required":["key","include_metadata","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["html-to-markdown"]},"include_metadata":{"type":"boolean","title":"Include Metadata","description":"When true, include metadata in the final markdown."},"css_selectors":{"title":"CSS Selectors","type":"array","uniqueItems":true,"items":{"type":"string","title":"CSS Selectors","minLength":1},"minItems":1}}},{"type":"object","title":"Modify or add an HTML attribute","description":"Modify or add an HTML attribute on elements matched by a CSS selector. Supports variables via {{ varName }} syntax in the attribute value.","required":["key","modifications"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["modify-attribute"]},"modifications":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["css_selector","attribute_name","attribute_value"],"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"attribute_name":{"type":"string","title":"Attribute name","minLength":1,"pattern":"^[a-zA-Z_:][a-zA-Z0-9_:.-]*$"},"attribute_value":{"type":"string","title":"Attribute value","minLength":1}}}}}},{"type":"object","title":"Fix inlinks (rewrite <a href> via dataset)","description":"Rewrites <a href> attributes whose value matches a dataset key (the original URL) to the corresponding new_url. The dataset is preloaded in engine memory at config push time.","required":["key","dataset_id"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["fix-inlinks"]},"dataset_id":{"type":"string","title":"Dataset ID","description":"Dataset ID storing (key=old_url, value={new_url}) entries. Must use the INLINKS_FIX_ prefix and only uppercase letters / underscores, matching the data_storage datasetId pattern.","pattern":"^INLINKS_FIX_[A-Z_]+$"},"match_mode":{"type":"string","title":"Match mode","description":"How to compare the absolute href against the dataset keys (old_urls). If omitted, the engine defaults to ignore_fragment.","enum":["exact","ignore_querystring","ignore_fragment"]}}}]},"uniqueItems":true}}},"uniqueItems":true,"default":[]}}}}},"metadata":{"type":"object","additionalProperties":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}}}},"put":{"summary":"Update Seo Recommendation settings","tags":["Seo Recommendation"],"description":"Deploy your SEO recommendations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SEO Recommendations","description":"The seo recommendations allows you to easily set up advanced SEO recipes on target","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"recommendations":{"type":"array","items":{"type":"object","required":["name","recipes","datasets"],"oneOf":[{"type":"object","required":["target"]},{"type":"object","required":["target_ref"]}],"additionalProperties":false,"properties":{"uuid":{"type":"string","format":"uuid","title":"UUID","description":"Unique identifier for the recommendation (UUID). Generated by the database when creating a new recommendation"},"name":{"type":"string","title":"Recommendation name","description":"Name of the recommendation"},"description":{"type":"string","title":"Recommendation description","description":"Description of the recommendation","default":""},"app":{"type":"string","title":"Managing app","description":"Marks the recommendation as managed by a specific app. Hidden from the SEO Recommendations UI when set."},"example_url":{"type":"string","title":"Example Url","description":"An example url on which the recommendation will be applied. (For testing purposes)"},"scheduledFrom":{"type":"string","format":"date-time","title":"Scheduled enable time","description":"ISO 8601 UTC datetime at which the recommendation will be automatically enabled"},"scheduledTo":{"type":"string","format":"date-time","title":"Scheduled disable time","description":"ISO 8601 UTC datetime at which the recommendation will be automatically disabled"},"enabled":{"type":"boolean","title":"Enable","default":true},"csr":{"type":"boolean","default":false,"description":"Recommendation will be reinjected on the page if change is detected"},"target_ref":{"type":"string","minLength":1,"title":"Target reference","description":"ID of a registry target whose context targets this recommendation"},"target":{"title":"Target context","description":"Define a context defining a target","type":"object","minProperties":1,"additionalProperties":false,"properties":{"request_url":{"oneOf":[{"title":"The Request URL is the complete URL sent to Fasterize by the browser. It contains the protocol, hostname, path and query parameters","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"request_path":{"oneOf":[{"type":"object","title":"The Request Path is the part starting with a /. The query parameters are not in the request_path","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}}]},"user_agent":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"match_any":{"type":"array","minItems":1,"items":{"type":"string","format":"regex"}}}},{"title":"HTTP header User-Agent","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}]},"device_type":{"title":"Device Type - User Agent Classification","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string","enum":["desktop_recent","mobile","tablet","old","bot","bot_ai","bot_mobile"]}}}},"client_ip":{"title":"Browser IP address in V4 or V6 format or CIDR","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}},"remote_ip":{"title":"Remote IP address (CDN or corporate proxy address)","type":"object","additionalProperties":false,"properties":{"in":{"type":"array","minItems":1,"items":{"type":"string"}}}}}},"datasets":{"type":"array","maxItems":10,"default":[],"items":{"type":"object","required":["id","key"],"properties":{"id":{"title":"ID","description":"Datastorage dataset id to use for this recommendation","type":"string","pattern":"^[A-Z_]+$","example":"METADATAS"},"key":{"anyOf":[{"type":"string","title":"Use URL as key","description":"Use the URL as key to retrieve the value from the dataset","enum":["REQ_URL"]},{"type":"string","title":"Key","description":"The key to the value from the dataset","minLength":1}]},"spread":{"type":"boolean","title":"Spread the values at the variables context root","description":"If the value is an object it will be merged with the variables context. If a variable has the same name as a key in the object, the value from the dataset will be used at the key in resulting context."},"alias":{"type":"string","pattern":"^[a-zA-Z0-9_]+$","title":"Value alias at the variables context root","description":"Makes the value accessible at the given key name","minLength":1,"maxLength":100}}}},"variables":{"type":"object","title":"User defined variables usable in this recommendation","description":"Define variables that can be used in the recipes","default":{},"additionalProperties":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"extraction":{"type":"string","enum":["text","html","attribute"]},"attribute":{"type":"string","minLength":1,"maxLength":500},"value":{"type":"string","maxLength":5000,"minLength":1},"select_all":{"description":"Turns the variable into an array with the values from all matches","type":"boolean"},"select_nth":{"description":"Select the nth element matched by the css selector from the start of the list (first element = 1)","type":"integer","minimum":1,"maximum":9007199254740991},"select_nth_from_last":{"description":"Select the nth element matched by the css selector from the end of the list (last element = 1)","type":"integer","minimum":1,"maximum":9007199254740991},"secret":{"description":"Marks the variable as a secret value","type":"boolean"},"source_key":{"type":"string","minLength":1,"maxLength":100}},"if":{"oneOf":[{"required":["value"]},{"required":["secret","source_key"],"properties":{"secret":{"enum":[true]}}}]},"then":{"properties":{"value":{},"secret":{},"source_key":{}},"additionalProperties":false},"else":{"required":["css_selector","extraction"],"allOf":[{"if":{"properties":{"extraction":{"enum":["attribute"]}}},"then":{"required":["attribute"]}},{"if":{"required":["select_all"],"properties":{"select_all":{"enum":[true]}}},"then":{"not":{"required":["select_nth","select_nth_from_last"]}},"else":{"if":{"required":["select_nth"]},"then":{"not":{"required":["select_nth_from_last"]}},"else":{"required":["select_nth_from_last"]}}}]}}},"recipes":{"type":"array","minItems":1,"items":{"oneOf":[{"type":"object","title":"Upsert <title> tag","description":"Update or insert the title tag in the HTML content (head section)","required":["key","title"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-title-tag"]},"title":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <meta name=\"description\"> tag","description":"Update or insert the meta description tag in the HTML content (head section)","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-meta-description-tag"]},"content":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <link rel=\"canonical\"> tag","description":"Update or insert the canonical link tag in the HTML content (head section). The does not modify HTTP header Link","required":["key","href"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-canonical-link-tag"]},"href":{"type":"string","minLength":1}}},{"type":"object","title":"Upsert <meta name=\"robots\"> tag","description":"Update or insert the meta \"robots\" tag in the HTML content (head section).","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-meta-robots-tag"]},"content":{"type":"array","minItems":1,"items":{"type":"string","enum":["all","index","noindex","follow","nofollow","none","noarchive","nositelinkssearchbox","indexifembedded","nosnippet","notranslate","noimageindex"]},"uniqueItems":true},"overwriteHeader":{"type":"boolean","title":"Overwrite X-Robots-Tag header","description":"If true, also sets the X-Robots-Tag HTTP response header with the same content as the meta tag."}}},{"type":"object","title":"Update heading tag","description":"Update <h1>,<h2>,<h3>,<h4>,<h5> or <h6> tags","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["update-heading-tag"]},"replacements":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["css_selector","text"],"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"text":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Upsert <link hreflang=\"\"> tags","description":"Update or insert the \"hreflang\" property of a <link> tag.","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-hreflang-link-tag"]},"replacements":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["url","hreflang"],"properties":{"url":{"type":"string","minLength":1},"hreflang":{"type":"string","description":"format is ISO lang code or x-default","pattern":"^([a-z]{2}(-[A-Z]{2})?|x-default)$"}}}}}},{"type":"object","title":"Add SEO text or internal net linking","required":["key","modifications"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["add-seo-content"]},"modifications":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"operations":{"title":"Possible operations on HTML tags","type":"array","minItems":1,"items":{"type":"object","required":["action","html_content"],"additionalProperties":false,"properties":{"action":{"type":"string","enum":["prepend_inside","append_inside","insert_after_outside","insert_before_outside"]},"html_content":{"type":"string","minLength":1}}}}}}}}},{"type":"object","title":"Switch tags name via a CSS selector but keep attributes","required":["key","replacements"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["replace-tag-name"]},"replacements":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"new_tag_name":{"type":"string","title":"New tag name","minLength":1}}}}}},{"type":"object","title":"Hide links tag","description":"replace anchor tag by a span tag","required":["key","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["hide-links"]},"css_selectors":{"title":"CSS Selectors","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","title":"CSS Selectors","minLength":1}}}},{"type":"object","title":"Insert or replace JSON-LD script tag","required":["key","content"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-schema-org-tag"]},"content":{"type":"string"}}},{"type":"object","title":"Insert or replace Open Graph tags","required":["key","tags"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-open-graph-tag"]},"tags":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","content"],"properties":{"name":{"type":"string","pattern":"^og:[a-z_:]+$"},"content":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Insert or replace Twitter Card tags","required":["key","tags"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["upsert-twitter-card-tag"]},"tags":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","content"],"properties":{"name":{"type":"string","pattern":"^twitter:[a-z:]+$"},"content":{"type":"string","minLength":1}}}}}},{"type":"object","title":"Remove a tag via css selector","required":["key","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["remove-tags"]},"css_selectors":{"type":"array","minItems":1,"items":{"type":"string","title":"CSS Selectors","minLength":1},"uniqueItems":true}}},{"type":"object","title":"Edge Rewriter via CSS selector","required":["key","script","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["edge-rewriter"]},"script":{"title":"Javascript script used to modify the dom via CSS selector","type":"string"},"version":{"type":"integer","enum":[1],"title":"Script version","description":"Version number of the script. Some utility functions might be added in future versions."},"css_selectors":{"title":"DOM elements filtered by CSS Selectors","description":"Selected elements are set as input for the script","type":"array","items":{"type":"string"}}}},{"type":"object","title":"Html to Markdown","description":"Transform html files to markdown for AI bots","required":["key","include_metadata","css_selectors"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["html-to-markdown"]},"include_metadata":{"type":"boolean","title":"Include Metadata","description":"When true, include metadata in the final markdown."},"css_selectors":{"title":"CSS Selectors","type":"array","uniqueItems":true,"items":{"type":"string","title":"CSS Selectors","minLength":1},"minItems":1}}},{"type":"object","title":"Modify or add an HTML attribute","description":"Modify or add an HTML attribute on elements matched by a CSS selector. Supports variables via {{ varName }} syntax in the attribute value.","required":["key","modifications"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["modify-attribute"]},"modifications":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["css_selector","attribute_name","attribute_value"],"properties":{"css_selector":{"type":"string","title":"CSS Selectors","minLength":1},"attribute_name":{"type":"string","title":"Attribute name","minLength":1,"pattern":"^[a-zA-Z_:][a-zA-Z0-9_:.-]*$"},"attribute_value":{"type":"string","title":"Attribute value","minLength":1}}}}}},{"type":"object","title":"Fix inlinks (rewrite <a href> via dataset)","description":"Rewrites <a href> attributes whose value matches a dataset key (the original URL) to the corresponding new_url. The dataset is preloaded in engine memory at config push time.","required":["key","dataset_id"],"additionalProperties":false,"properties":{"key":{"type":"string","enum":["fix-inlinks"]},"dataset_id":{"type":"string","title":"Dataset ID","description":"Dataset ID storing (key=old_url, value={new_url}) entries. Must use the INLINKS_FIX_ prefix and only uppercase letters / underscores, matching the data_storage datasetId pattern.","pattern":"^INLINKS_FIX_[A-Z_]+$"},"match_mode":{"type":"string","title":"Match mode","description":"How to compare the absolute href against the dataset keys (old_urls). If omitted, the engine defaults to ignore_fragment.","enum":["exact","ignore_querystring","ignore_fragment"]}}}]},"uniqueItems":true}}},"uniqueItems":true,"default":[]}}}}},"metadata":{"type":"object","additionalProperties":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"description":"The seo recommendations allows you to easily set up advanced SEO recipes on target"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/service-worker":{"get":{"summary":"Get Service Worker settings","tags":["Service Worker"],"description":"Add service worker features to your website.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Adds a service worker script to your website.","content":{"application/json":{"schema":{"type":"object","title":"Service Worker","description":"Adds a service worker script to your website.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":true,"required":["content"],"properties":{"client_script":{"description":"Whether to use a script unique to the client or the generic platform one","type":"boolean","default":false},"content":{"description":"The script's filename as stored in s3 in the client's scripts bucket or the platform scripts bucket","title":"s3 filename","type":"string","default":""},"force_unregister":{"description":"Force unregistration of the Service Worker on end-user browsers. When enabled, a script will be injected to remove the SW instead of registering it.","type":"boolean","default":false}}}}}}}}}}}},"put":{"summary":"Update Service Worker settings","tags":["Service Worker"],"description":"Add service worker features to your website.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Service Worker","description":"Adds a service worker script to your website.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":true,"required":["content"],"properties":{"client_script":{"description":"Whether to use a script unique to the client or the generic platform one","type":"boolean","default":false},"content":{"description":"The script's filename as stored in s3 in the client's scripts bucket or the platform scripts bucket","title":"s3 filename","type":"string","default":""},"force_unregister":{"description":"Force unregistration of the Service Worker on end-user browsers. When enabled, a script will be injected to remove the SW instead of registering it.","type":"boolean","default":false}}}}}}}}},"description":"Adds a service worker script to your website."},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-service-worker:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/sitemap":{"get":{"summary":"Get Sitemap settings","tags":["Sitemap"],"description":"Manage your sitemaps.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap:read"]}],"responses":{"200":{"description":"Manage your website sitemaps","content":{"application/json":{"schema":{"type":"object","title":"Sitemap","description":"Manage your website sitemaps","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"sitemaps":{"title":"Sitemap items","type":"array","items":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-zA-Z0-9_-]+.xml$"},"default":[],"uniqueItems":true}}}}}}}}}}}},"put":{"summary":"Update Sitemap settings","tags":["Sitemap"],"description":"Manage your sitemaps.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Sitemap","description":"Manage your website sitemaps","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"sitemaps":{"title":"Sitemap items","type":"array","items":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-zA-Z0-9_-]+.xml$"},"default":[],"uniqueItems":true}}}}}}}}},"description":"Manage your website sitemaps"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner":{"get":{"summary":"Get Sitemap Cleaner settings","tags":["Sitemap Cleaner"],"description":"Define crawlers with filtering options to eliminate pages from your sitemap when they would damage your SEO.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Remove URLS harmful for your SEO from your sitemaps","content":{"application/json":{"schema":{"type":"object","title":"Sitemap Cleaner","description":"Remove URLS harmful for your SEO from your sitemaps","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"description":"Application Sitemap Cleaner, configure jobs to filter out URLs from original sitemaps, eg. urls responding with a 404 status","properties":{"crawlers":{"type":"object","description":"Configure the crawlers which will be parsing and filtering the sitemaps.\nSitemap can be a sitemap index or a sitemap file.\nTo crawl multiple sitemaps, you can define multiple crawlers.","default":{},"additionalProperties":{"description":"Individual crawler configuration.","type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the crawler is enabled or not","type":"boolean","default":true},"sitemap_url":{"description":"URL for the sitemap entrypoint of the crawl (can be a sitemap index)","type":"string","format":"uri","maxLength":1000},"frequency":{"description":"Frequency of the crawler's execution in AWS Cloud Watch cron scheduler format","type":"string"},"rate_limit_per_min":{"type":"number","description":"Number of urls hit per minute made by the crawler","default":300,"minimum":1,"maximum":600},"concurrency":{"type":"number","description":"Number of concurrent requests the crawler will make","default":10,"minimum":1,"maximum":1000},"timeout":{"description":"Number of seconds after which the crawler will stop waiting for a response","type":"number","default":120,"minimum":1,"maximum":300},"filters":{"description":"Filters to apply to each url in the sitemap","type":"object","additionalProperties":false,"properties":{"status_code":{"description":"If a url responds with one of the status codes in this array, the url will be filtered out","type":"array","items":{"type":"number","minimum":100,"maximum":999}},"canonical":{"description":"When activated, if a canonical tag with a href attribute different from the url hit is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"noindex":{"description":"When activated, if a meta robots noindex tag is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"error_on_fetch":{"description":"Behavior when fetching a URL fails: keep it in the sitemap (default) or remove it","type":"string","enum":["keep","remove"],"default":"keep"}}},"transformations":{"description":"URL transformations to apply before filtering","type":"object","additionalProperties":false,"properties":{"convert_http_to_https":{"description":"Convert HTTP URLs to HTTPS","type":"boolean","default":false},"convert_relative_to_absolute":{"description":"Convert relative URLs to absolute using sitemap domain","type":"boolean","default":false},"normalize_www":{"description":"Normalize host to match sitemap domain (add/remove www)","type":"boolean","default":false}}}}}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"description":"Application Sitemap Cleaner, configure jobs to filter out URLs from original sitemaps, eg. urls responding with a 404 status","properties":{"crawlers":{"type":"object","description":"Configure the crawlers which will be parsing and filtering the sitemaps.\nSitemap can be a sitemap index or a sitemap file.\nTo crawl multiple sitemaps, you can define multiple crawlers.","default":{},"additionalProperties":{"description":"Individual crawler configuration.","type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the crawler is enabled or not","type":"boolean","default":true},"sitemap_url":{"description":"URL for the sitemap entrypoint of the crawl (can be a sitemap index)","type":"string","format":"uri","maxLength":1000},"frequency":{"description":"Frequency of the crawler's execution in AWS Cloud Watch cron scheduler format","type":"string"},"rate_limit_per_min":{"type":"number","description":"Number of urls hit per minute made by the crawler","default":300,"minimum":1,"maximum":600},"concurrency":{"type":"number","description":"Number of concurrent requests the crawler will make","default":10,"minimum":1,"maximum":1000},"timeout":{"description":"Number of seconds after which the crawler will stop waiting for a response","type":"number","default":120,"minimum":1,"maximum":300},"filters":{"description":"Filters to apply to each url in the sitemap","type":"object","additionalProperties":false,"properties":{"status_code":{"description":"If a url responds with one of the status codes in this array, the url will be filtered out","type":"array","items":{"type":"number","minimum":100,"maximum":999}},"canonical":{"description":"When activated, if a canonical tag with a href attribute different from the url hit is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"noindex":{"description":"When activated, if a meta robots noindex tag is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"error_on_fetch":{"description":"Behavior when fetching a URL fails: keep it in the sitemap (default) or remove it","type":"string","enum":["keep","remove"],"default":"keep"}}},"transformations":{"description":"URL transformations to apply before filtering","type":"object","additionalProperties":false,"properties":{"convert_http_to_https":{"description":"Convert HTTP URLs to HTTPS","type":"boolean","default":false},"convert_relative_to_absolute":{"description":"Convert relative URLs to absolute using sitemap domain","type":"boolean","default":false},"normalize_www":{"description":"Normalize host to match sitemap domain (add/remove www)","type":"boolean","default":false}}}}}}}}}}}}}}}}}}}},"put":{"summary":"Update Sitemap Cleaner settings","tags":["Sitemap Cleaner"],"description":"Define crawlers with filtering options to eliminate pages from your sitemap when they would damage your SEO.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Sitemap Cleaner","description":"Remove URLS harmful for your SEO from your sitemaps","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"description":"Application Sitemap Cleaner, configure jobs to filter out URLs from original sitemaps, eg. urls responding with a 404 status","properties":{"crawlers":{"type":"object","description":"Configure the crawlers which will be parsing and filtering the sitemaps.\nSitemap can be a sitemap index or a sitemap file.\nTo crawl multiple sitemaps, you can define multiple crawlers.","default":{},"additionalProperties":{"description":"Individual crawler configuration.","type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the crawler is enabled or not","type":"boolean","default":true},"sitemap_url":{"description":"URL for the sitemap entrypoint of the crawl (can be a sitemap index)","type":"string","format":"uri","maxLength":1000},"frequency":{"description":"Frequency of the crawler's execution in AWS Cloud Watch cron scheduler format","type":"string"},"rate_limit_per_min":{"type":"number","description":"Number of urls hit per minute made by the crawler","default":300,"minimum":1,"maximum":600},"concurrency":{"type":"number","description":"Number of concurrent requests the crawler will make","default":10,"minimum":1,"maximum":1000},"timeout":{"description":"Number of seconds after which the crawler will stop waiting for a response","type":"number","default":120,"minimum":1,"maximum":300},"filters":{"description":"Filters to apply to each url in the sitemap","type":"object","additionalProperties":false,"properties":{"status_code":{"description":"If a url responds with one of the status codes in this array, the url will be filtered out","type":"array","items":{"type":"number","minimum":100,"maximum":999}},"canonical":{"description":"When activated, if a canonical tag with a href attribute different from the url hit is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"noindex":{"description":"When activated, if a meta robots noindex tag is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"error_on_fetch":{"description":"Behavior when fetching a URL fails: keep it in the sitemap (default) or remove it","type":"string","enum":["keep","remove"],"default":"keep"}}},"transformations":{"description":"URL transformations to apply before filtering","type":"object","additionalProperties":false,"properties":{"convert_http_to_https":{"description":"Convert HTTP URLs to HTTPS","type":"boolean","default":false},"convert_relative_to_absolute":{"description":"Convert relative URLs to absolute using sitemap domain","type":"boolean","default":false},"normalize_www":{"description":"Normalize host to match sitemap domain (add/remove www)","type":"boolean","default":false}}}}}}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"description":"Application Sitemap Cleaner, configure jobs to filter out URLs from original sitemaps, eg. urls responding with a 404 status","properties":{"crawlers":{"type":"object","description":"Configure the crawlers which will be parsing and filtering the sitemaps.\nSitemap can be a sitemap index or a sitemap file.\nTo crawl multiple sitemaps, you can define multiple crawlers.","default":{},"additionalProperties":{"description":"Individual crawler configuration.","type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the crawler is enabled or not","type":"boolean","default":true},"sitemap_url":{"description":"URL for the sitemap entrypoint of the crawl (can be a sitemap index)","type":"string","format":"uri","maxLength":1000},"frequency":{"description":"Frequency of the crawler's execution in AWS Cloud Watch cron scheduler format","type":"string"},"rate_limit_per_min":{"type":"number","description":"Number of urls hit per minute made by the crawler","default":300,"minimum":1,"maximum":600},"concurrency":{"type":"number","description":"Number of concurrent requests the crawler will make","default":10,"minimum":1,"maximum":1000},"timeout":{"description":"Number of seconds after which the crawler will stop waiting for a response","type":"number","default":120,"minimum":1,"maximum":300},"filters":{"description":"Filters to apply to each url in the sitemap","type":"object","additionalProperties":false,"properties":{"status_code":{"description":"If a url responds with one of the status codes in this array, the url will be filtered out","type":"array","items":{"type":"number","minimum":100,"maximum":999}},"canonical":{"description":"When activated, if a canonical tag with a href attribute different from the url hit is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"noindex":{"description":"When activated, if a meta robots noindex tag is found in the html body at the given url, the url will be filtered out","type":"boolean","default":false},"error_on_fetch":{"description":"Behavior when fetching a URL fails: keep it in the sitemap (default) or remove it","type":"string","enum":["keep","remove"],"default":"keep"}}},"transformations":{"description":"URL transformations to apply before filtering","type":"object","additionalProperties":false,"properties":{"convert_http_to_https":{"description":"Convert HTTP URLs to HTTPS","type":"boolean","default":false},"convert_relative_to_absolute":{"description":"Convert relative URLs to absolute using sitemap domain","type":"boolean","default":false},"normalize_www":{"description":"Normalize host to match sitemap domain (add/remove www)","type":"boolean","default":false}}}}}}}}}}}}}}}}},"description":"Remove URLS harmful for your SEO from your sitemaps"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/smart-inp":{"get":{"summary":"Get Smart Inp settings","tags":["Smart Inp"],"description":"Improve your INP metric.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Optimize Interaction to Next Paint (INP) by delaying event listeners from third-party scripts to improve page responsiveness.","content":{"application/json":{"schema":{"type":"object","title":"SmartInp - INP Optimization","description":"Optimize Interaction to Next Paint (INP) by delaying event listeners from third-party scripts to improve page responsiveness.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"whitelist_domains":{"type":"array","title":"Whitelist Delayed Domains","description":"Additional domains to add to the default list of domains whose event listeners will be delayed","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"blacklist_domains":{"type":"array","title":"Blacklist Delayed Domains","description":"Domains to exclude from the default list of delayed domains","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"filename":{"type":"string","title":"Script Filename","description":"Filename for the SmartInp script. Do not specify the .js or .min.js extension","pattern":"^[a-zA-Z0-9-_]+$","default":"smart-inp"},"client_script":{"type":"boolean","default":false,"title":"Use Client Script","description":"Whether to use a script unique to the client or the generic platform one"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"whitelist_domains":{"type":"array","title":"Whitelist Delayed Domains","description":"Additional domains to add to the default list of domains whose event listeners will be delayed","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"blacklist_domains":{"type":"array","title":"Blacklist Delayed Domains","description":"Domains to exclude from the default list of delayed domains","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"filename":{"type":"string","title":"Script Filename","description":"Filename for the SmartInp script. Do not specify the .js or .min.js extension","pattern":"^[a-zA-Z0-9-_]+$","default":"smart-inp"},"client_script":{"type":"boolean","default":false,"title":"Use Client Script","description":"Whether to use a script unique to the client or the generic platform one"}},"additionalProperties":false}}}}}}}}}}}}},"put":{"summary":"Update Smart Inp settings","tags":["Smart Inp"],"description":"Improve your INP metric.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SmartInp - INP Optimization","description":"Optimize Interaction to Next Paint (INP) by delaying event listeners from third-party scripts to improve page responsiveness.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"whitelist_domains":{"type":"array","title":"Whitelist Delayed Domains","description":"Additional domains to add to the default list of domains whose event listeners will be delayed","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"blacklist_domains":{"type":"array","title":"Blacklist Delayed Domains","description":"Domains to exclude from the default list of delayed domains","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"filename":{"type":"string","title":"Script Filename","description":"Filename for the SmartInp script. Do not specify the .js or .min.js extension","pattern":"^[a-zA-Z0-9-_]+$","default":"smart-inp"},"client_script":{"type":"boolean","default":false,"title":"Use Client Script","description":"Whether to use a script unique to the client or the generic platform one"}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"whitelist_domains":{"type":"array","title":"Whitelist Delayed Domains","description":"Additional domains to add to the default list of domains whose event listeners will be delayed","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"blacklist_domains":{"type":"array","title":"Blacklist Delayed Domains","description":"Domains to exclude from the default list of delayed domains","items":{"type":"string","title":"Domain","description":"Domain name (e.g., example.com)"},"default":[]},"filename":{"type":"string","title":"Script Filename","description":"Filename for the SmartInp script. Do not specify the .js or .min.js extension","pattern":"^[a-zA-Z0-9-_]+$","default":"smart-inp"},"client_script":{"type":"boolean","default":false,"title":"Use Client Script","description":"Whether to use a script unique to the client or the generic platform one"}},"additionalProperties":false}}}}}}}}}},"description":"Optimize Interaction to Next Paint (INP) by delaying event listeners from third-party scripts to improve page responsiveness."},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-smart-inp:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/static-cache":{"get":{"summary":"Get Static Cache settings","tags":["Static Cache"],"description":"Manage your asset cache","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-static-cache:read"]}],"responses":{"200":{"description":"This section contains cache segmentation and cache-control settings","content":{"application/json":{"schema":{"title":"Cache section","description":"This section contains cache segmentation and cache-control settings","type":"object","additionalProperties":false,"properties":{"policies":{"type":"object","title":"Static object and image caching","description":"Serve static objects directly from an edge cache, avoiding the need to retrieve them from your web server.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":true},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":true},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":2592000}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":true},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":true},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":2592000}}}}}}}}}},"asset_urls":{"type":"object","additionalProperties":false,"properties":{"url_versioning":{"type":"object","title":"Static resources versioning","description":"Ensure that assets have a unique URL by adding a version number in the query parameters. It then forces all caches to be updated (CDN, browser, ...) after a cache purge on Fasterize","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version number added in the URL","description":"This value is automatically updated after a cache purge on the domain","default":1}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version number added in the URL","description":"This value is automatically updated after a cache purge on the domain","default":1}},"additionalProperties":false}}}}}}}},"strip_query_params":{"type":"object","title":"Strip query parameters on static resources","description":"Random query parameters on static resources prevent efficient caching","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"params":{"type":"array","title":"Query Parameters","description":"Specify query parameters that will be omitted. Leave blank to remove all parameters","default":[],"items":{"type":"string"}}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"params":{"type":"array","title":"Query Parameters","description":"Specify query parameters that will be omitted. Leave blank to remove all parameters","default":[],"items":{"type":"string"}}},"additionalProperties":false}}}}}}}},"fix_url_encoding":{"type":"object","title":"Encode URL parameters","description":"Encoding URL parameters is a workaround of an Internet Explorer bug which send URL chars with the wrong encoding.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}}}},"prevent_cdn_cache":{"title":"Prevent CDN cache on discovery mode or abtest mode","type":"boolean","default":false},"fix_ambiguous_cache_control":{"type":"object","title":"Don't fix missing or ambiguous cache-control header","description":"Some CDN may cache private page when there is no cache-control header","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object"}}}}}}}}}}}},"put":{"summary":"Update Static Cache settings","tags":["Static Cache"],"description":"Manage your asset cache","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Cache section","description":"This section contains cache segmentation and cache-control settings","type":"object","additionalProperties":false,"properties":{"policies":{"type":"object","title":"Static object and image caching","description":"Serve static objects directly from an edge cache, avoiding the need to retrieve them from your web server.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":true},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":true},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":2592000}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"cache_on_browser":{"title":"Cache the page on the browser","type":"boolean","default":true},"cache_on_cdn":{"title":"Cache the page on the CDN without segmentation","type":"boolean","default":true},"ttl":{"title":"Time to live in the different cache layer : Fasterize, CDN, browser","description":"Two special values : 0 means no-cache and -1 means keep ttl from the origin response","type":"integer","default":2592000}}}}}}}}}},"asset_urls":{"type":"object","additionalProperties":false,"properties":{"url_versioning":{"type":"object","title":"Static resources versioning","description":"Ensure that assets have a unique URL by adding a version number in the query parameters. It then forces all caches to be updated (CDN, browser, ...) after a cache purge on Fasterize","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version number added in the URL","description":"This value is automatically updated after a cache purge on the domain","default":1}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"version":{"type":"integer","title":"Version number added in the URL","description":"This value is automatically updated after a cache purge on the domain","default":1}},"additionalProperties":false}}}}}}}},"strip_query_params":{"type":"object","title":"Strip query parameters on static resources","description":"Random query parameters on static resources prevent efficient caching","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"params":{"type":"array","title":"Query Parameters","description":"Specify query parameters that will be omitted. Leave blank to remove all parameters","default":[],"items":{"type":"string"}}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"params":{"type":"array","title":"Query Parameters","description":"Specify query parameters that will be omitted. Leave blank to remove all parameters","default":[],"items":{"type":"string"}}},"additionalProperties":false}}}}}}}},"fix_url_encoding":{"type":"object","title":"Encode URL parameters","description":"Encoding URL parameters is a workaround of an Internet Explorer bug which send URL chars with the wrong encoding.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object"}}}}}}}}}},"prevent_cdn_cache":{"title":"Prevent CDN cache on discovery mode or abtest mode","type":"boolean","default":false},"fix_ambiguous_cache_control":{"type":"object","title":"Don't fix missing or ambiguous cache-control header","description":"Some CDN may cache private page when there is no cache-control header","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object"}}}}}}}}},"description":"This section contains cache segmentation and cache-control settings"},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-static-cache:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/third-parties":{"get":{"summary":"Get Self Hosting settings","tags":["Self Hosting"],"description":"Optimize Third Parties","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-third-parties:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"self_hosting":{"type":"object","title":"Self-host third party domain","description":"Self-host third party domain to decrease the number of resolved domains or use the website CDN for an external resource.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"allowed_domains":{"title":"Domain names to consider","description":"URL of domain names declared here will be rewritten if found in the page","type":"array","default":["edgepic.fzcdn.net"],"items":{"type":"string","format":"hostname"}},"skip_unsharding_for_primary_domain":{"title":"Skip unsharding for page domain","description":"Don't rewrite URL for the primary domain","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"allowed_domains":{"title":"Domain names to consider","description":"URL of domain names declared here will be rewritten if found in the page","type":"array","default":["edgepic.fzcdn.net"],"items":{"type":"string","format":"hostname"}},"skip_unsharding_for_primary_domain":{"title":"Skip unsharding for page domain","description":"Don't rewrite URL for the primary domain","type":"boolean","default":false}},"additionalProperties":false}}}}}}}}}}}}}}},"put":{"summary":"Update Self Hosting settings","tags":["Self Hosting"],"description":"Optimize Third Parties","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"self_hosting":{"type":"object","title":"Self-host third party domain","description":"Self-host third party domain to decrease the number of resolved domains or use the website CDN for an external resource.","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"allowed_domains":{"title":"Domain names to consider","description":"URL of domain names declared here will be rewritten if found in the page","type":"array","default":["edgepic.fzcdn.net"],"items":{"type":"string","format":"hostname"}},"skip_unsharding_for_primary_domain":{"title":"Skip unsharding for page domain","description":"Don't rewrite URL for the primary domain","type":"boolean","default":false}},"additionalProperties":false}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"allowed_domains":{"title":"Domain names to consider","description":"URL of domain names declared here will be rewritten if found in the page","type":"array","default":["edgepic.fzcdn.net"],"items":{"type":"string","format":"hostname"}},"skip_unsharding_for_primary_domain":{"title":"Skip unsharding for page domain","description":"Don't rewrite URL for the primary domain","type":"boolean","default":false}},"additionalProperties":false}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-third-parties:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/traffic-limiter":{"get":{"summary":"Get Traffic Limiter settings","tags":["Traffic Limiter"],"description":"Regulate traffic on your site","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-traffic-limiter:read"]}],"responses":{"200":{"description":"This section contains waiting rooms, maintenance page...","content":{"application/json":{"schema":{"title":"Traffic Management","description":"This section contains waiting rooms, maintenance page...","type":"object","additionalProperties":false,"properties":{"traffic_limiter":{"type":"object","title":"Traffic limiter","description":"The system is triggered as soon as the sessions number reaches a maximum","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"bypass_by_client_ip":{"title":"List of IP addresses that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"IP addresses label"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"IP addresses list","minItems":1,"items":{"type":"string"}}}}},"bypass_by_request_url":{"title":"List of URL that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Request path"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"Request path list","minItems":1,"items":{"type":"string","minLength":1}}}}},"ttl":{"title":"Maximum time for a session. The session is considered inactive after this period. Note that the longer the time indicated, the faster the system will saturate.","type":"integer","default":300},"max_sessions":{"title":"Number of sessions from which the Traffic Limiter must be activated","type":"integer","default":300},"overflow_page":{"title":"Waiting room URL to which your clients should be redirected","type":"string","default":"/"}}}}}}},"waiting_rooms":{"type":"object","title":"Waiting Room","description":"The virtual waiting room lets you control online traffic in high-demand situations to deliver superior experiences and treat visitors fairly","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"bypass_audience":{"title":"List of IP addresses that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"IP addresses label"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"IP addresses list","minItems":1,"items":{"type":"string"}}}}},"rooms":{"title":"Waiting room","type":"array","items":{"type":"object","properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"name":{"title":"Waiting room name","type":"string"},"description":{"title":"Waiting room description","type":"string","default":""},"mode":{"title":"Waiting room activation mode","description":"\"redirection“ mode means that waiting users are redirected to a page specified in redirection_page via a HTTP redirection. \"default_waiting_room\" mode means that the page shown to waiting users is branded by Fasterize.","type":"string","enum":["redirection","default_waiting_room"],"default":"redirection"},"redirection_page":{"title":"Waiting room URL to which your clients should be redirected","type":"string"},"queue_all":{"title":"Queue all","description":"If queue_all is true, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.","type":"boolean","default":false},"path":{"title":"Path (protected website area)","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the first declared waiting room will be chosen. Wildcards and query parameters are not supported.","type":"string","pattern":"^/.*","default":"/"},"session_duration":{"title":"Session duration","description":"Lifetime of a cookie (in minutes) set by Fasterize for users who get access to the route. If a user is not seen by Fasterize again in that time period, they will be treated as a new user that visits the route.","type":"integer","default":5,"minimum":1,"maximum":30},"total_active_users":{"title":"Total active users","description":"Sets the total number of active user sessions on the path at a point in time. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.","type":"integer","minimum":1,"maximum":10000},"session_renewal":{"title":"Session renewal","description":"Enable automatic renewal of session cookies. If false, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If true, a user's session cookie will be automatically renewed on every request. This may allow more users than the limit in the protected area","type":"boolean","default":true},"queueing_method":{"title":"Queueing method","description":"Sets the queueing method used by the waiting room. Value fifo means First-In-First-Out queue where customers gain access in the order they arrived.","type":"string","enum":["fifo"],"default":"fifo"},"excluded_paths":{"title":"Path Exclusions","description":"Bypass specific paths under the path you have configured for your waiting room, if you do not want your waiting room to apply to these paths.","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Request path","minLength":1},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"Request path list","minItems":1,"items":{"type":"string","minLength":1}}}}}},"required":["enabled","name","total_active_users","redirection_page"]},"default":[]}},"required":["bypass_audience","rooms"]}}}}}}}}}}}},"put":{"summary":"Update Traffic Limiter settings","tags":["Traffic Limiter"],"description":"Regulate traffic on your site","requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Traffic Management","description":"This section contains waiting rooms, maintenance page...","type":"object","additionalProperties":false,"properties":{"traffic_limiter":{"type":"object","title":"Traffic limiter","description":"The system is triggered as soon as the sessions number reaches a maximum","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","additionalProperties":false,"properties":{"bypass_by_client_ip":{"title":"List of IP addresses that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"IP addresses label"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"IP addresses list","minItems":1,"items":{"type":"string"}}}}},"bypass_by_request_url":{"title":"List of URL that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Request path"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"Request path list","minItems":1,"items":{"type":"string","minLength":1}}}}},"ttl":{"title":"Maximum time for a session. The session is considered inactive after this period. Note that the longer the time indicated, the faster the system will saturate.","type":"integer","default":300},"max_sessions":{"title":"Number of sessions from which the Traffic Limiter must be activated","type":"integer","default":300},"overflow_page":{"title":"Waiting room URL to which your clients should be redirected","type":"string","default":"/"}}}}}}},"waiting_rooms":{"type":"object","title":"Waiting Room","description":"The virtual waiting room lets you control online traffic in high-demand situations to deliver superior experiences and treat visitors fairly","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":false},"parameters":{"type":"object","properties":{"bypass_audience":{"title":"List of IP addresses that bypass the waiting room","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"IP addresses label"},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"IP addresses list","minItems":1,"items":{"type":"string"}}}}},"rooms":{"title":"Waiting room","type":"array","items":{"type":"object","properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"name":{"title":"Waiting room name","type":"string"},"description":{"title":"Waiting room description","type":"string","default":""},"mode":{"title":"Waiting room activation mode","description":"\"redirection“ mode means that waiting users are redirected to a page specified in redirection_page via a HTTP redirection. \"default_waiting_room\" mode means that the page shown to waiting users is branded by Fasterize.","type":"string","enum":["redirection","default_waiting_room"],"default":"redirection"},"redirection_page":{"title":"Waiting room URL to which your clients should be redirected","type":"string"},"queue_all":{"title":"Queue all","description":"If queue_all is true, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.","type":"boolean","default":false},"path":{"title":"Path (protected website area)","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the first declared waiting room will be chosen. Wildcards and query parameters are not supported.","type":"string","pattern":"^/.*","default":"/"},"session_duration":{"title":"Session duration","description":"Lifetime of a cookie (in minutes) set by Fasterize for users who get access to the route. If a user is not seen by Fasterize again in that time period, they will be treated as a new user that visits the route.","type":"integer","default":5,"minimum":1,"maximum":30},"total_active_users":{"title":"Total active users","description":"Sets the total number of active user sessions on the path at a point in time. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.","type":"integer","minimum":1,"maximum":10000},"session_renewal":{"title":"Session renewal","description":"Enable automatic renewal of session cookies. If false, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If true, a user's session cookie will be automatically renewed on every request. This may allow more users than the limit in the protected area","type":"boolean","default":true},"queueing_method":{"title":"Queueing method","description":"Sets the queueing method used by the waiting room. Value fifo means First-In-First-Out queue where customers gain access in the order they arrived.","type":"string","enum":["fifo"],"default":"fifo"},"excluded_paths":{"title":"Path Exclusions","description":"Bypass specific paths under the path you have configured for your waiting room, if you do not want your waiting room to apply to these paths.","type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["target","label"],"properties":{"label":{"type":"string","title":"Request path","minLength":1},"enabled":{"type":"boolean","title":"Activation","default":true},"target":{"type":"array","title":"Request path list","minItems":1,"items":{"type":"string","minLength":1}}}}}},"required":["enabled","name","total_active_users","redirection_page"]},"default":[]}},"required":["bypass_audience","rooms"]}}}}}}}}},"description":"This section contains waiting rooms, maintenance page..."},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-traffic-limiter:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/configs/{id}/apps/webperf":{"get":{"summary":"Get Webperf Data Monitoring settings","tags":["Webperf Data Monitoring"],"description":"Real User Monitoring","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-webperf:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","title":"Inject webperf monitoring script","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"speed_index_ratio":{"type":"integer","default":10,"minimum":0,"maximum":100},"collect_attribution_for_good_rating":{"type":"boolean","default":false},"attribution_sampling":{"type":"integer","default":100,"minimum":0,"maximum":100},"collect_stats_sampling":{"description":"% of user sessions for which the webperf stats should be collected","type":"integer","default":50,"minimum":0,"maximum":100}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"speed_index_ratio":{"type":"integer","default":10,"minimum":0,"maximum":100},"collect_attribution_for_good_rating":{"type":"boolean","default":false},"attribution_sampling":{"type":"integer","default":100,"minimum":0,"maximum":100},"collect_stats_sampling":{"description":"% of user sessions for which the webperf stats should be collected","type":"integer","default":50,"minimum":0,"maximum":100}}}}}}}}}}}}}}},"put":{"summary":"Update Webperf Data Monitoring settings","tags":["Webperf Data Monitoring"],"description":"Real User Monitoring","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Inject webperf monitoring script","description":"","additionalProperties":false,"required":["installed","settings"],"properties":{"installed":{"title":"Do we considered this setting ?","type":"boolean","default":true},"settings":{"title":"Settings applied by default on all pages","type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"speed_index_ratio":{"type":"integer","default":10,"minimum":0,"maximum":100},"collect_attribution_for_good_rating":{"type":"boolean","default":false},"attribution_sampling":{"type":"integer","default":100,"minimum":0,"maximum":100},"collect_stats_sampling":{"description":"% of user sessions for which the webperf stats should be collected","type":"integer","default":50,"minimum":0,"maximum":100}}}}},"target_settings":{"title":"Setting applied only on a given target. The first matching target in the list is considered","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"target":{"title":"Target ID for the given setting","type":"string"},"settings":{"type":"object","additionalProperties":false,"required":["enabled","parameters"],"properties":{"enabled":{"title":"Enable","type":"boolean","default":true},"parameters":{"type":"object","additionalProperties":false,"properties":{"speed_index_ratio":{"type":"integer","default":10,"minimum":0,"maximum":100},"collect_attribution_for_good_rating":{"type":"boolean","default":false},"attribution_sampling":{"type":"integer","default":100,"minimum":0,"maximum":100},"collect_stats_sampling":{"description":"% of user sessions for which the webperf stats should be collected","type":"integer","default":50,"minimum":0,"maximum":100}}}}}}}}}}}}},"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-webperf:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Id of the operation","type":"number","example":125},"name":{"description":"Name of the operation","type":"string","pattern":"^[^<>\"{}]{1,200}$","example":"Deployement of the certificate of example.com"},"userId":{"description":"User id of who launch the operation","type":"number","example":10},"configId":{"description":"Website config id on which the operation is applied","type":"string","example":"10"},"type":{"description":"Type of operation","type":"string","example":"DEPLOY_CERT"},"status":{"description":"Status of the current operation","type":"string","example":"ONGOING"},"progress":{"description":"Overall message of the current status","type":"number","example":10},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"createdAt":{"description":"Creation date of certificate metadata in database","type":"string","format":"date-time","example":{}},"updatedAt":{"description":"Last update date of certificate metadata in database","type":"string","format":"date-time","example":{}},"applicationId":{"description":"Application identifier","type":"string","example":"domain"},"targetId":{"description":"Home Page","type":"string","example":"home_page"},"subject":{"description":"The subject of the operation","type":"string","example":"CONFIG"},"user":{"description":"Linked user"},"project":{"description":"Linked project"},"website":{"description":"Linked website"},"target":{"description":"Linked target"},"informations":{"description":"Linked informations"},"requestId":{"description":"Request id of the operation","type":"string","example":"1234567890"}}}}}}}}},"/v2/bulk-redirection/template":{"get":{"summary":"Get the template of the redirection file","tags":["Bulk Redirection"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{}}},"/v2/configs/{id}/apps/bulk-redirection/upload":{"post":{"summary":"Upload a redirection file","tags":["Bulk Redirection"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-redirection:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-redirection/url":{"get":{"summary":"Download a bulk redirection file","tags":["Bulk Redirection"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-redirection:read"]}],"responses":{"200":{"description":"URL for downloading CSV File","content":{"application/json":{"schema":{"type":"object","description":"URL for downloading CSV File","properties":{"url":{"type":"string"}}}}}}}}},"/v2/configs/{id}/apps/bulk-redirection/validate":{"post":{"summary":"Validate a bulk redirection file","tags":["Bulk Redirection"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-seo:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-redirection/sync/preview":{"get":{"summary":"Preview candidates for a redirect against the deployed file","tags":["Bulk Redirection"],"description":"Returns counts and samples of 4xx URLs (candidates for a redirect or a 410) that are not yet in the deployed bulk-redirection file (newCount), compared to those already covered (existingCount). The sampleUrls field shows the first 3 new candidates, and hasDeployedFile tells whether a bulk-redirection file is deployed at all (independently of existingCount, which can be 0 even with a file deployed). Read-only, no side effects.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-redirection:read"]}],"responses":{"200":{"description":"Diff counts and sample URLs of 4xx candidates against the deployed bulk-redirection file. New candidates can be converted to a redirect or a 410; sampleUrls contains the first 3 new candidates; hasDeployedFile tells whether a bulk-redirection file is deployed at all, independently of existingCount (which can be 0 even when a file exists, if none of its rows overlap with the current candidates).","content":{"application/json":{"schema":{"type":"object","description":"Diff counts and sample URLs of 4xx candidates against the deployed bulk-redirection file. New candidates can be converted to a redirect or a 410; sampleUrls contains the first 3 new candidates; hasDeployedFile tells whether a bulk-redirection file is deployed at all, independently of existingCount (which can be 0 even when a file exists, if none of its rows overlap with the current candidates).","properties":{"newCount":{"type":"number"},"existingCount":{"type":"number"},"sampleUrls":{"type":"array","items":{"type":"string"}},"hasDeployedFile":{"type":"boolean"}},"required":["newCount","existingCount","sampleUrls","hasDeployedFile"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/bulk-redirection/sync/download":{"get":{"summary":"Download the deployed file merged with new 4xx candidates","tags":["Bulk Redirection"],"description":"Streams a CSV: the currently deployed bulk-redirection rows, plus one new row per crawled 4xx candidate not already present as a Source. The Code column is left blank on generated rows — a candidate may warrant a 410 or a 301 to an equivalent page, so the choice is left to a human editing the downloaded file. Nothing is deployed by this call.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-redirection:read"]}],"responses":{}}},"/v2/bulk-seo/template":{"get":{"summary":"Get the template of the bulk seo file","tags":["Bulk Seo"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{}}},"/v2/configs/{id}/apps/bulk-seo/validate":{"post":{"summary":"Validate a bulk seo file","tags":["Bulk Seo"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-seo:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-seo/upload":{"post":{"summary":"Upload a bulk seo file","tags":["Bulk Seo"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-seo:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-seo/url":{"get":{"summary":"Download a bulk seo file","tags":["Bulk Seo"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-seo:read"]}],"responses":{"200":{"description":"URL for downloading CSV File","content":{"application/json":{"schema":{"type":"object","description":"URL for downloading CSV File","properties":{"url":{"type":"string"}}}}}}}}},"/v2/bulk-url-rewriting/template":{"get":{"summary":"Get the template of the bulk URL Rewriting file","tags":["Bulk Url Rewriting"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{}}},"/v2/configs/{id}/apps/bulk-url-rewriting/validate":{"post":{"summary":"Validate a bulk URL Rewriting file","tags":["Bulk Url Rewriting"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-bulk-url-rewriting:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-url-rewriting/upload":{"post":{"summary":"Upload a bulk URL Rewriting file","tags":["Bulk Url Rewriting"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-url-rewriting:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/bulk-url-rewriting/url":{"get":{"summary":"Download a bulk url rewriting file","tags":["Bulk Url Rewriting"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-bulk-url-rewriting:read"]}],"responses":{"200":{"description":"URL for downloading CSV File","content":{"application/json":{"schema":{"type":"object","description":"URL for downloading CSV File","properties":{"url":{"type":"string"}}}}}}}}},"/v2/configs/{id}/apps/sitemap/validate":{"post":{"summary":"Validate a Sitemap XML file","tags":["Sitemap"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/sitemap/upload":{"post":{"summary":"Upload a sitemap XML file","tags":["Sitemap"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/sitemap/{filename}":{"delete":{"summary":"Delete a sitemap XML file","tags":["Sitemap"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap:write"]}],"responses":{"200":{"description":"File Delete Response","content":{"application/json":{"schema":{"type":"object","description":"File Delete Response","properties":{}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"get":{"summary":"Get a sitemap XML file content","tags":["Sitemap"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap:write"]}],"responses":{"200":{"description":"File Delete Response","content":{"application/json":{"schema":{"type":"object","description":"File Delete Response","properties":{}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/validate":{"post":{"summary":"Validate a data storage file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/data-storage/validate-structuredjson":{"post":{"summary":"Validate a structured JSON data storage file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/validate":{"post":{"summary":"Validate a data storage file and its values against a schema automatically generated from the first value imported in the dataset.","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/schema":{"get":{"summary":"Get a schema automatically generated from the first value imported in the dataset.","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string","nullable":true}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/validate-deletion":{"post":{"summary":"Validate a data storage deletion file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/upload":{"post":{"summary":"Upload a data storage JSON file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$"},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/upload-structuredjson":{"post":{"summary":"Upload a data storage JSON file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$"},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}":{"delete":{"summary":"Delete a data storage dataset","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$"},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"post":{"summary":"Add an entry to a data storage dataset","tags":["Data Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"data":{"type":"object","additionalProperties":true}},"required":["key","data"]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"datasetId","required":true}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/upload-deletion":{"post":{"summary":"Upload a data storage deletion JSON file","tags":["Data Storage"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$"},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"File Upload Response","content":{"application/json":{"schema":{"type":"object","description":"File Upload Response","properties":{"nbKeys":{"type":"number","description":"The number of keys uploaded","example":125}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/page":{"get":{"summary":"Get paginated data from a dataset","tags":["Data Storage"],"parameters":[{"schema":{"type":"number","minimum":0},"in":"query","name":"page","required":true},{"schema":{"type":"number","minimum":1,"maximum":100},"in":"query","name":"pageSize","required":true},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$"},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-data-storage:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"}},"additionalProperties":true}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/items/{*}":{"delete":{"summary":"Delete a key from a dataset","tags":["Data Storage"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"datasetId","required":true},{"schema":{"type":"string"},"in":"path","name":"*","required":true}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"put":{"summary":"Edit an entry in a data storage dataset","tags":["Data Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"datasetId","required":true},{"schema":{"type":"string"},"in":"path","name":"*","required":true}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"get":{"summary":"Get a single entry from a dataset","tags":["Data Storage"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"datasetId","required":true},{"schema":{"type":"string"},"in":"path","name":"*","required":true}],"security":[{"Secret API key":[],"JWT":["application:read","app-data-storage:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/data-storage/{datasetId}/template/api-connector":{"post":{"summary":"Create an api connector dataset","tags":["Data Storage"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1,"pattern":"^[A-Z_]+$","maxLength":25},"example":"MY_DATASET","in":"path","name":"datasetId","required":true,"description":"Dataset ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/api_connectors/test":{"post":{"summary":"Test an api connector api call","tags":["Api Connectors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"Secret API key":[],"JWT":["application:write","app-data-storage:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/sitemap-cleaner/admin":{"get":{"summary":"Get sitemap cleaner admin dashboard data","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"from","required":false,"description":"Start date filter (YYYY-MM-DD)"},{"schema":{"type":"string"},"in":"query","name":"to","required":false,"description":"End date filter (YYYY-MM-DD)"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{}}},"/v2/configs/{id}/apps/sitemap-cleaner/{filename}":{"delete":{"summary":"Delete an optimized sitemap XML file","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"File Delete Response","content":{"application/json":{"schema":{"type":"object","description":"File Delete Response","properties":{}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"get":{"summary":"Get a sitemap XML file content","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Cleaned XML sitemap file content","content":{"application/json":{"schema":{"type":"string","description":"Cleaned XML sitemap file content"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/reports/{filename}":{"get":{"summary":"Get a sitemap cleaning report","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"CSV file content","content":{"application/json":{"schema":{"type":"string","description":"CSV file content"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/reports/list":{"get":{"summary":"Get a list of available sitemap cleaning reports","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"files":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/crawlers/{crawlerName}/preview":{"post":{"summary":"Generate a preview of the estimated impact of a sitemap cleaner crawler","tags":["Sitemap Cleaner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"crawlerConfig":{"type":"object","description":"Optional crawler configuration to preview (uses saved config if omitted)"},"compareWithSaved":{"type":"boolean","description":"If true and crawlerConfig is provided, include comparison with saved config"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sitemapUrl":{"type":"string"},"sitemapFormat":{"type":"string"},"isSitemapIndex":{"type":"boolean"},"childSitemapCount":{"type":"number"},"totalUrls":{"type":"number"},"estimatedUrlsToRemove":{"type":"number"},"estimatedUrlsToKeep":{"type":"number"},"estimatedRemovalByType":{"type":"object","additionalProperties":{"type":"number"}},"sampleSize":{"type":"number"},"sampleResults":{"type":"array"},"estimatedCrawlTimeMinutes":{"type":"number"},"warnings":{"type":"array","items":{"type":"string"}},"htmlFiltersActive":{"type":"boolean"},"htmlFilterWarning":{"type":"string"},"transformationsApplied":{"type":"object"},"comparison":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/crawlers/{crawlerName}/launch":{"post":{"summary":"Launch a sitemap cleaner crawler job immediately","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"launched":{"type":"boolean"}},"type":"object"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/sitemap-cleaner/send-daily-digest":{"post":{"summary":"Send sitemap cleaner daily digest emails","tags":["Sitemap Cleaner"],"description":"Aggregates all sitemap cleaner operations from the last 24 hours and sends consolidated digest emails to subscribers. Called by a scheduled Scaleway job.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"emailsSent":{"type":"number"},"configsProcessed":{"type":"number"}}}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/email-subscription":{"get":{"summary":"Get current user email subscription for sitemap cleaner","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribed":{"type":"boolean"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}},"nullable":true}}}}}}}},"put":{"summary":"Subscribe to or update email preferences for sitemap cleaner","tags":["Sitemap Cleaner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string","format":"email"}},"lang":{"type":"string","enum":["en","fr"]}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribed":{"type":"boolean"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}},"nullable":true}}}}}}}},"delete":{"summary":"Unsubscribe from sitemap cleaner email notifications","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribed":{"type":"boolean"}}}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/email-subscribers":{"get":{"summary":"List all email subscribers for sitemap cleaner on a config","tags":["Sitemap Cleaner"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-sitemap-cleaner:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"number"},"email":{"type":"string"},"givenName":{"type":"string"},"familyName":{"type":"string"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}}}}}}}}}}}}},"put":{"summary":"Set the full list of email subscribers for sitemap cleaner on a config","tags":["Sitemap Cleaner"],"description":"Replaces the subscriber list. Removes users no longer present and upserts new entries, preserving existing preferences when not provided.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscribers"],"properties":{"subscribers":{"type":"array","items":{"type":"object","required":["userId"],"properties":{"userId":{"type":"integer"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}}}}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"number"},"email":{"type":"string"},"givenName":{"type":"string"},"familyName":{"type":"string"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}}}}}}}}}}}}}},"/v2/configs/{id}/apps/sitemap-cleaner/email-subscribers/{userId}":{"patch":{"summary":"Update email preferences for a specific subscriber","tags":["Sitemap Cleaner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"security":[{"Secret API key":[],"JWT":["application:write","app-sitemap-cleaner:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribed":{"type":"boolean"},"preferences":{"type":"object","properties":{"dailyDigestEnabled":{"type":"boolean"},"failureAlertEnabled":{"type":"boolean"},"additionalCcEmails":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"}},"nullable":true}}}}}}}}},"/v2/admin/sitemap-cleaner/email-digest/status":{"get":{"summary":"Get sitemap cleaner email digest job status","tags":["Sitemap Cleaner"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"cronSchedule":{"type":"string"},"jobDefinitionId":{"type":"string"}}}}}}}}},"/v2/admin/sitemap-cleaner/email-digest/enable":{"post":{"summary":"Enable sitemap cleaner email digest scheduled job","tags":["Sitemap Cleaner"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"cronSchedule":{"type":"string"},"jobDefinitionId":{"type":"string"}}}}}}}}},"/v2/admin/sitemap-cleaner/email-digest/disable":{"post":{"summary":"Disable sitemap cleaner email digest scheduled job","tags":["Sitemap Cleaner"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"disabled":{"type":"boolean"}}}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts":{"get":{"summary":"Get the list of available service worker scripts for this config id","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"files":{"type":"array","items":{"type":"string"},"default":[]}},"additionalProperties":false,"required":["files"],"type":"object"}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts/internal":{"get":{"summary":"Get the list of available internal service worker scripts for this config id","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"files":{"type":"array","items":{"type":"string"},"default":[]}},"additionalProperties":false,"required":["files"],"type":"object"}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts/url/{filename}":{"get":{"summary":"Get the service worker script url.","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts/internal/url/{filename}":{"get":{"summary":"Get the service worker script url.","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts/{filename}":{"get":{"summary":"Read an available service worker scripts for this config id","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/service-worker/scripts/internal/{filename}":{"get":{"summary":"Read an available service worker scripts for this config id","tags":["Service Worker"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-service-worker:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts":{"get":{"summary":"Get the list of available smart-inp scripts for this config id","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"files":{"type":"array","items":{"type":"string"},"default":[]}},"additionalProperties":false,"required":["files"],"type":"object"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts/internal":{"get":{"summary":"Get the list of available internal smart-inp scripts for this config id","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"properties":{"files":{"type":"array","items":{"type":"string"},"default":[]}},"additionalProperties":false,"required":["files"],"type":"object"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts/url/{filename}":{"get":{"summary":"Get the smart-inp script url.","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts/internal/url/{filename}":{"get":{"summary":"Get the smart-inp script url.","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts/{filename}":{"get":{"summary":"Read an available smart-inp scripts for this config id","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/smart-inp/scripts/internal/{filename}":{"get":{"summary":"Read an available smart-inp scripts for this config id","tags":["Smart Inp"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1},"example":"my-sitemap.xml","in":"path","name":"filename","required":true,"description":"Filename"}],"security":[{"Secret API key":[],"JWT":["application:read","app-smart-inp:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/configs/{id}/apps/events-tracking/{eventName}":{"get":{"summary":"Get events tracking counts between two dates for a given event key, per day and per optimization status, counting events as unique when they occur within the timeframe","tags":["Events Tracking"],"parameters":[{"schema":{"type":"string","format":"date"},"in":"query","name":"startDate","required":false},{"schema":{"type":"string","format":"date"},"in":"query","name":"endDate","required":false},{"schema":{"type":"number","minimum":0,"maximum":86400,"default":5},"in":"query","name":"timeframeSeconds","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"in":"path","name":"eventName","required":true}],"security":[{"Secret API key":[],"JWT":["application:read","app-events-tracking:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"optimized":{"type":"integer"},"non_optimized":{"type":"integer"}},"required":["date","optimized","non_optimized"]}}}}}}}},"/v2/configs/{id}/secrets/{secretKey}":{"put":{"summary":"Update a secret value","tags":["Secret"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"secretValue":{"type":"string","minLength":1,"maxLength":1000}},"required":["secretValue"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"in":"path","name":"secretKey","required":true}],"security":[{"Secret API key":[],"JWT":["secrets:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"]}}}}}},"delete":{"summary":"Delete a secret value","tags":["Secret"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9-_]+$"},"in":"path","name":"secretKey","required":true}],"security":[{"Secret API key":[],"JWT":["secrets:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"]}}}}}}},"/v2/configs/{id}/secrets":{"get":{"summary":"Get paginated secrets","tags":["Secret"],"parameters":[{"schema":{"type":"number","minimum":0},"in":"query","name":"page","required":true},{"schema":{"type":"number","minimum":1,"maximum":100},"in":"query","name":"pageSize","required":true},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["secrets:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"]}}}}}}},"/v2/configs/{id}/apps/shield/security-rules":{"get":{"summary":"List the zone's security rules, in evaluation order","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["rules"],"properties":{"rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"post":{"summary":"Create a security rule, optionally at a given position (default: append)","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","expression","action","enabled"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"expression":{"type":"string","minLength":1,"maxLength":4096,"description":"Cloudflare rule expression. Syntax is validated via Cloudflare; fields requiring an add-on Shield does not have (Bot Management ML score, JA3/JA4 — cf.bot_management.*) are rejected."},"enabled":{"type":"boolean"},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"action":{"type":"string","enum":["block","managed_challenge","js_challenge","challenge","log","skip"]},"position":{"type":"object","additionalProperties":false,"required":["index"],"properties":{"index":{"type":"integer","minimum":2,"description":"Absolute 1-based slot. Slot 1 is reserved for the Fasterize system allow rule."}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule expression is invalid.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string","enum":["invalid_rule_expression"]},"details":{"type":"object","properties":{"reason":{"type":"string"},"details":{"type":"array","items":{"type":"string"}}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The request would modify or displace the Fasterize system allow rule.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/security-rules/{rule_id}":{"put":{"summary":"Replace a security rule's modeled fields","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","expression","action","enabled","version"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"expression":{"type":"string","minLength":1,"maxLength":4096,"description":"Cloudflare rule expression. Syntax is validated via Cloudflare; fields requiring an add-on Shield does not have (Bot Management ML score, JA3/JA4 — cf.bot_management.*) are rejected."},"enabled":{"type":"boolean"},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"action":{"type":"string","minLength":1,"maxLength":64,"description":"The rule's action. Either one Shield can author (block, managed_challenge, js_challenge, challenge, log, skip), or the action the rule already carries — send it back unchanged to edit a rule Shield cannot author."},"version":{"type":"string","minLength":1,"maxLength":64}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule expression is invalid.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string","enum":["invalid_rule_expression"]},"details":{"type":"object","properties":{"reason":{"type":"string"},"details":{"type":"array","items":{"type":"string"}}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"The requested action is not one Shield can author.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string","enum":["unmodeled_rule_action"]},"details":{"type":"object","properties":{"action":{"type":"string"},"current_action":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule is managed by the firewall app and must be changed through its settings.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"},"ref":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"The request would modify or displace the Fasterize system allow rule.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such security rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"409":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The security rule has been modified since it was read.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"version":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}},"delete":{"summary":"Delete a security rule","tags":["Shield"],"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule is managed by the firewall app and must be changed through its settings.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"},"ref":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"The request would modify or displace the Fasterize system allow rule.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such security rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}}},"/v2/configs/{id}/apps/shield/security-rules/{rule_id}/move":{"post":{"summary":"Reposition a security rule without changing its definition","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["position"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"position":{"type":"object","additionalProperties":false,"required":["index"],"properties":{"index":{"type":"integer","minimum":2,"description":"Absolute 1-based slot. Slot 1 is reserved for the Fasterize system allow rule."}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule is managed by the firewall app and must be changed through its settings.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"},"ref":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"The request would modify or displace the Fasterize system allow rule.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such security rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}}},"/v2/configs/{id}/apps/shield/validate-expr":{"post":{"summary":"Validate a rule expression (syntax + supported fields) without writing","tags":["Shield"],"description":"Live editor helper: always answers 200 with `{ valid }`. An invalid expression is a result, not an error — `{ valid: false, reason, details }` — so the editor renders red inline. Reuses the same validation the create/replace paths run on write.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["expression"],"properties":{"expression":{"type":"string","minLength":1,"maxLength":4096,"description":"Cloudflare rule expression. Syntax is validated via Cloudflare; fields requiring an add-on Shield does not have (Bot Management ML score, JA3/JA4 — cf.bot_management.*) are rejected."}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["valid"],"properties":{"valid":{"type":"boolean"},"reason":{"type":"string","enum":["UNSUPPORTED_FIELD","FOREIGN_LIST","INVALID_SYNTAX"]},"details":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/managed-rulesets":{"get":{"summary":"Get Shield managed rulesets configuration","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["cloudflare_managed","browser_integrity_check"],"properties":{"cloudflare_managed":{"type":"object","additionalProperties":false,"required":["mode","overrides"],"properties":{"mode":{"type":"string"},"overrides":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["rule_id","enabled"],"properties":{"rule_id":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"browser_integrity_check":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"put":{"summary":"Replace Shield managed rulesets configuration","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["cloudflare_managed","browser_integrity_check"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"cloudflare_managed":{"type":"object","additionalProperties":false,"required":["mode","overrides"],"properties":{"mode":{"type":"string","enum":["off","exec","log"]},"overrides":{"type":"array","maxItems":1000,"items":{"type":"object","additionalProperties":false,"required":["rule_id","enabled"],"properties":{"rule_id":{"type":"string","minLength":1,"maxLength":200},"action":{"type":"string","maxLength":64},"enabled":{"type":"boolean"}}}}}},"browser_integrity_check":{"type":"boolean","description":"Browser Integrity Check: inspect the visitor’s browser for headers commonly associated with spammers and bots. Applied as the Cloudflare `browser_check` zone setting, not a managed-phase rule."}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["cloudflare_managed","browser_integrity_check"],"properties":{"cloudflare_managed":{"type":"object","additionalProperties":false,"required":["mode","overrides"],"properties":{"mode":{"type":"string"},"overrides":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["rule_id","enabled"],"properties":{"rule_id":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"browser_integrity_check":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/managed-rulesets/waf/catalog":{"get":{"summary":"List the WAF managed ruleset rule catalog (rule id, tags, default action, status)","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["rules"],"properties":{"rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["rule_id","description","categories","default_action","enabled"],"properties":{"rule_id":{"type":"string"},"description":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"default_action":{"type":"string"},"enabled":{"type":"boolean"}}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/rate-limits":{"get":{"summary":"List the zone's rate-limiting rules, in evaluation order","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["rules"],"properties":{"rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"},"requests_per_period":{"type":"integer"},"period":{"type":"integer"},"mitigation_timeout":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}},"counting_expression":{"type":"string"},"requests_to_origin":{"type":"boolean"},"score_per_period":{"type":"integer"},"score_response_header_name":{"type":"string"}}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"post":{"summary":"Create a rate-limiting rule, optionally at a given position (default: append)","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","expression","action","requests_per_period","period","mitigation_timeout","enabled"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"expression":{"type":"string","minLength":1,"maxLength":4096,"description":"Cloudflare rule expression. Syntax is validated via Cloudflare; fields requiring an add-on Shield does not have (Bot Management ML score, JA3/JA4 — cf.bot_management.*) are rejected."},"action":{"type":"string","enum":["block","challenge","js_challenge","managed_challenge","log"]},"requests_per_period":{"type":"integer","minimum":1},"period":{"type":"integer","minimum":1},"mitigation_timeout":{"type":"integer","minimum":0},"enabled":{"type":"boolean"},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"position":{"type":"object","additionalProperties":false,"required":["index"],"properties":{"index":{"type":"integer","minimum":1,"description":"Absolute 1-based slot. No slot is reserved on the rate-limit phase."}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"},"requests_per_period":{"type":"integer"},"period":{"type":"integer"},"mitigation_timeout":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}},"counting_expression":{"type":"string"},"requests_to_origin":{"type":"boolean"},"score_per_period":{"type":"integer"},"score_response_header_name":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule expression is invalid.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string","enum":["invalid_rule_expression"]},"details":{"type":"object","properties":{"reason":{"type":"string"},"details":{"type":"array","items":{"type":"string"}}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/rate-limits/{rule_id}":{"put":{"summary":"Replace a rate-limiting rule's modeled fields","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","expression","action","requests_per_period","period","mitigation_timeout","enabled","version"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"expression":{"type":"string","minLength":1,"maxLength":4096,"description":"Cloudflare rule expression. Syntax is validated via Cloudflare; fields requiring an add-on Shield does not have (Bot Management ML score, JA3/JA4 — cf.bot_management.*) are rejected."},"action":{"type":"string","enum":["block","challenge","js_challenge","managed_challenge","log"]},"requests_per_period":{"type":"integer","minimum":1},"period":{"type":"integer","minimum":1},"mitigation_timeout":{"type":"integer","minimum":0},"enabled":{"type":"boolean"},"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"version":{"type":"string","minLength":1,"maxLength":64}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"},"requests_per_period":{"type":"integer"},"period":{"type":"integer"},"mitigation_timeout":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}},"counting_expression":{"type":"string"},"requests_to_origin":{"type":"boolean"},"score_per_period":{"type":"integer"},"score_response_header_name":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rule expression is invalid.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string","enum":["invalid_rule_expression"]},"details":{"type":"object","properties":{"reason":{"type":"string"},"details":{"type":"array","items":{"type":"string"}}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such rate-limit rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}},"409":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"The rate-limit rule has been modified since it was read.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"version":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}},"delete":{"summary":"Delete a rate-limiting rule","tags":["Shield"],"parameters":[{"schema":{"type":"string","maxLength":255},"example":"Activate png to webp conversion","in":"query","name":"description","required":false,"description":"Description of the operation"},{"schema":{"type":"string","maxLength":255},"example":"374","in":"query","name":"supportTicket","required":false,"description":"Support ticket for the operation"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such rate-limit rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}}},"/v2/configs/{id}/apps/shield/rate-limits/{rule_id}/move":{"post":{"summary":"Reposition a rate-limiting rule without changing its definition","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["position"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"position":{"type":"object","additionalProperties":false,"required":["index"],"properties":{"index":{"type":"integer","minimum":1,"description":"Absolute 1-based slot. No slot is reserved on the rate-limit phase."}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"},{"schema":{"type":"string","minLength":1,"maxLength":64},"example":"143c1005ad3e4edc996619fc3a752246","in":"path","name":"rule_id","required":true,"description":"Cloudflare rule ID, as returned by the security-rules list"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","version","name","expression","action","enabled"],"properties":{"id":{"type":"string"},"ref":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"expression":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"},"requests_per_period":{"type":"integer"},"period":{"type":"integer"},"mitigation_timeout":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}},"counting_expression":{"type":"string"},"requests_to_origin":{"type":"boolean"},"score_per_period":{"type":"integer"},"score_response_header_name":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"description":"Error response","anyOf":[{"type":"object","description":"No such rate-limit rule in this zone.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"rule_id":{"type":"string"}}}},"required":["statusCode","error","reason","message","details"]},{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}]}}}}}}},"/v2/configs/{id}/apps/shield/bots":{"get":{"summary":"Get Shield bot settings","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["definitely_automated","verified_bots","static_resource_protection","js_detection"],"properties":{"definitely_automated":{"type":"string"},"verified_bots":{"type":"string"},"static_resource_protection":{"type":"boolean"},"js_detection":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"put":{"summary":"Replace Shield bot settings","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["definitely_automated","verified_bots","static_resource_protection","js_detection"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"definitely_automated":{"type":"string","enum":["allow","block","managed_challenge"]},"verified_bots":{"type":"string","enum":["allow","block"]},"static_resource_protection":{"type":"boolean"},"js_detection":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["definitely_automated","verified_bots","static_resource_protection","js_detection"],"properties":{"definitely_automated":{"type":"string"},"verified_bots":{"type":"string"},"static_resource_protection":{"type":"boolean"},"js_detection":{"type":"boolean"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/security-headers":{"get":{"summary":"Get Shield security headers","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["override_origin","x_content_type_options","referrer_policy","x_frame_options","permissions_policy","coop","corp","hide_fingerprint_headers","csp","coep","hsts"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"override_origin":{"type":"boolean"},"x_content_type_options":{"type":"boolean"},"referrer_policy":{"type":"string","enum":[null,"no-referrer","no-referrer-when-downgrade","origin","origin-when-cross-origin","same-origin","strict-origin","strict-origin-when-cross-origin","unsafe-url"],"nullable":true},"x_frame_options":{"type":"string","enum":["off","SAMEORIGIN","DENY"]},"permissions_policy":{"type":"string","maxLength":1024,"nullable":true},"coop":{"type":"boolean"},"corp":{"type":"string","enum":["off","same-origin","same-site","cross-origin"]},"hide_fingerprint_headers":{"type":"boolean","description":"Remove technology-fingerprinting response headers (X-Powered-By, X-AspNet-Version, X-AspNetMvc-Version). The Server header is masked by Cloudflare’s proxy (Server: cloudflare) and is not part of this transform rule."},"csp":{"type":"object","additionalProperties":false,"required":["mode","policy"],"properties":{"mode":{"type":"string","enum":["off","report-only","enforce"]},"policy":{"type":"string","maxLength":8192}}},"coep":{"type":"string","enum":["off","report-only","require-corp"]},"hsts":{"type":"object","additionalProperties":false,"required":["enabled","max_age","include_sub_domains","preload"],"properties":{"enabled":{"type":"boolean"},"max_age":{"type":"integer","minimum":0},"include_sub_domains":{"type":"boolean"},"preload":{"type":"boolean"}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"put":{"summary":"Replace Shield security headers","tags":["Shield"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["override_origin","x_content_type_options","referrer_policy","x_frame_options","permissions_policy","coop","corp","hide_fingerprint_headers","csp","coep","hsts"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"override_origin":{"type":"boolean"},"x_content_type_options":{"type":"boolean"},"referrer_policy":{"type":"string","enum":[null,"no-referrer","no-referrer-when-downgrade","origin","origin-when-cross-origin","same-origin","strict-origin","strict-origin-when-cross-origin","unsafe-url"],"nullable":true},"x_frame_options":{"type":"string","enum":["off","SAMEORIGIN","DENY"]},"permissions_policy":{"type":"string","maxLength":1024,"nullable":true},"coop":{"type":"boolean"},"corp":{"type":"string","enum":["off","same-origin","same-site","cross-origin"]},"hide_fingerprint_headers":{"type":"boolean","description":"Remove technology-fingerprinting response headers (X-Powered-By, X-AspNet-Version, X-AspNetMvc-Version). The Server header is masked by Cloudflare’s proxy (Server: cloudflare) and is not part of this transform rule."},"csp":{"type":"object","additionalProperties":false,"required":["mode","policy"],"properties":{"mode":{"type":"string","enum":["off","report-only","enforce"]},"policy":{"type":"string","maxLength":8192}}},"coep":{"type":"string","enum":["off","report-only","require-corp"]},"hsts":{"type":"object","additionalProperties":false,"required":["enabled","max_age","include_sub_domains","preload"],"properties":{"enabled":{"type":"boolean"},"max_age":{"type":"integer","minimum":0},"include_sub_domains":{"type":"boolean"},"preload":{"type":"boolean"}}}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-shield:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["override_origin","x_content_type_options","referrer_policy","x_frame_options","permissions_policy","coop","corp","hide_fingerprint_headers","csp","coep","hsts"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"override_origin":{"type":"boolean"},"x_content_type_options":{"type":"boolean"},"referrer_policy":{"type":"string","enum":[null,"no-referrer","no-referrer-when-downgrade","origin","origin-when-cross-origin","same-origin","strict-origin","strict-origin-when-cross-origin","unsafe-url"],"nullable":true},"x_frame_options":{"type":"string","enum":["off","SAMEORIGIN","DENY"]},"permissions_policy":{"type":"string","maxLength":1024,"nullable":true},"coop":{"type":"boolean"},"corp":{"type":"string","enum":["off","same-origin","same-site","cross-origin"]},"hide_fingerprint_headers":{"type":"boolean","description":"Remove technology-fingerprinting response headers (X-Powered-By, X-AspNet-Version, X-AspNetMvc-Version). The Server header is masked by Cloudflare’s proxy (Server: cloudflare) and is not part of this transform rule."},"csp":{"type":"object","additionalProperties":false,"required":["mode","policy"],"properties":{"mode":{"type":"string","enum":["off","report-only","enforce"]},"policy":{"type":"string","maxLength":8192}}},"coep":{"type":"string","enum":["off","report-only","require-corp"]},"hsts":{"type":"object","additionalProperties":false,"required":["enabled","max_age","include_sub_domains","preload"],"properties":{"enabled":{"type":"boolean"},"max_age":{"type":"integer","minimum":0},"include_sub_domains":{"type":"boolean"},"preload":{"type":"boolean"}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/shield/security-headers/recommended-baseline":{"get":{"summary":"Get the recommended Shield security-headers baseline (a suggestion; not applied)","tags":["Shield"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-shield:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["override_origin","x_content_type_options","referrer_policy","x_frame_options","permissions_policy","coop","corp","hide_fingerprint_headers","csp","coep","hsts"],"properties":{"description":{"description":"Description of the operation","type":"string","maxLength":255,"example":"Activate png to webp conversion"},"supportTicket":{"description":"Support ticket for the operation","type":"string","maxLength":255,"example":"374"},"override_origin":{"type":"boolean"},"x_content_type_options":{"type":"boolean"},"referrer_policy":{"type":"string","enum":[null,"no-referrer","no-referrer-when-downgrade","origin","origin-when-cross-origin","same-origin","strict-origin","strict-origin-when-cross-origin","unsafe-url"],"nullable":true},"x_frame_options":{"type":"string","enum":["off","SAMEORIGIN","DENY"]},"permissions_policy":{"type":"string","maxLength":1024,"nullable":true},"coop":{"type":"boolean"},"corp":{"type":"string","enum":["off","same-origin","same-site","cross-origin"]},"hide_fingerprint_headers":{"type":"boolean","description":"Remove technology-fingerprinting response headers (X-Powered-By, X-AspNet-Version, X-AspNetMvc-Version). The Server header is masked by Cloudflare’s proxy (Server: cloudflare) and is not part of this transform rule."},"csp":{"type":"object","additionalProperties":false,"required":["mode","policy"],"properties":{"mode":{"type":"string","enum":["off","report-only","enforce"]},"policy":{"type":"string","maxLength":8192}}},"coep":{"type":"string","enum":["off","report-only","require-corp"]},"hsts":{"type":"object","additionalProperties":false,"required":["enabled","max_age","include_sub_domains","preload"],"properties":{"enabled":{"type":"boolean"},"max_age":{"type":"integer","minimum":0},"include_sub_domains":{"type":"boolean"},"preload":{"type":"boolean"}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-recommendation/preview":{"post":{"summary":"Generate a preview URL for SEO recommendation testing","tags":["Seo Recommendation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["testUrl","appConfig"],"properties":{"testUrl":{"type":"string","description":"The URL to test the recommendation on"},"appConfig":{"type":"object","description":"Full SEO recommendations app config"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-recommendation:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-recommendation/recommendations":{"post":{"summary":"Create a new SEO recommendation","tags":["Seo Recommendation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recommendation"],"properties":{"recommendation":{"type":"object","description":"The SEO recommendation to create"},"subscriberUserIds":{"type":"array","items":{"type":"integer"},"description":"Optional user IDs to subscribe to this recommendation"},"description":{"type":"string","description":"Operation description"},"supportTicket":{"type":"string","description":"Support ticket reference"}}}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation":{"type":"object","additionalProperties":true},"operation":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-recommendation/recommendations/{uuid}/duplicate":{"post":{"summary":"Duplicate an SEO recommendation","tags":["Seo Recommendation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name for the duplicated recommendation"},"description":{"type":"string","description":"Operation description"},"duplicateSchedule":{"type":"boolean","default":false,"description":"When true, copy scheduledFrom/scheduledTo from the source recommendation"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Config ID"},{"schema":{"type":"string"},"in":"path","name":"uuid","required":true,"description":"Recommendation UUID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation":{"type":"object","additionalProperties":true},"operation":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-recommendation/recommendations/{uuid}":{"put":{"summary":"Update an SEO recommendation","tags":["Seo Recommendation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recommendation"],"properties":{"recommendation":{"type":"object","description":"The updated SEO recommendation"},"description":{"type":"string","description":"Operation description"},"supportTicket":{"type":"string","description":"Support ticket reference"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Config ID"},{"schema":{"type":"string"},"in":"path","name":"uuid","required":true,"description":"Recommendation UUID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation":{"type":"object","additionalProperties":true},"operation":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}},"delete":{"summary":"Delete an SEO recommendation","tags":["Seo Recommendation"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Config ID"},{"schema":{"type":"string"},"in":"path","name":"uuid","required":true,"description":"Recommendation UUID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-recommendation/recommendations/{uuid}/status":{"patch":{"summary":"Toggle an SEO recommendation status","tags":["Seo Recommendation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Enable or disable the recommendation"},"description":{"type":"string","description":"Operation description"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Config ID"},{"schema":{"type":"string"},"in":"path","name":"uuid","required":true,"description":"Recommendation UUID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-seo-recommendation:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation":{"type":"object","additionalProperties":true},"operation":{"type":"object"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/fix":{"post":{"summary":"Upsert the canonical Inlinks recommendation and dataset","tags":["Inlinks"],"description":"Accepts a list of (old_url, new_url) pairs, merges them with the existing dataset, and upserts the system-managed inlinks SEO recommendation in the config. Incoming entries win on key conflict (same old_url → new_url overwrites).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["old_url","new_url"],"properties":{"old_url":{"type":"string","description":"The original URL to fix"},"new_url":{"type":"string","description":"The destination URL"},"fix_type":{"type":"string","enum":["auto","manual"],"description":"auto: the crawl-resolved destination as is, manual (default): a destination entered by the user"}},"additionalProperties":false}},"match_mode":{"type":"string","enum":["exact","ignore_querystring","ignore_fragment"],"default":"ignore_fragment","description":"URL matching mode for the fix-inlinks recipe"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation_uuid":{"type":"string"},"dataset_id":{"type":"string"},"entries_count":{"type":"number"},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/fix-all":{"post":{"summary":"Fix every eligible (auto_fix) Inlinks discovery in one run","tags":["Inlinks"],"description":"Resolves and fixes all auto-fixable discoveries server-side (up to a capped number, highest referrer_count first), applies any per-row overrides, then merges them into the dataset and upserts the system-managed inlinks recommendation like /fix.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"href_contains":{"type":"string","description":"Only fix eligible auto_fix rows whose URL matches this substring"},"match_mode":{"type":"string","enum":["exact","ignore_querystring","ignore_fragment"],"default":"ignore_fragment","description":"URL matching mode for the fix-inlinks recipe"},"overrides":{"type":"array","description":"Per-row new_url overrides applied on top of the auto-resolved target","items":{"type":"object","required":["old_url","new_url"],"properties":{"old_url":{"type":"string","description":"The original URL to fix"},"new_url":{"type":"string","description":"The destination URL override"}},"additionalProperties":false}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendation_uuid":{"type":"string"},"dataset_id":{"type":"string"},"entries_count":{"type":"number"},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/unfix":{"post":{"summary":"Remove entries from the Inlinks dataset (revert fixes)","tags":["Inlinks"],"description":"Accepts a list of old_urls and removes them from the canonical inlinks dataset. The recommendation itself is left in place (only its referenced dataset shrinks).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["old_urls"],"properties":{"old_urls":{"type":"array","minItems":1,"items":{"type":"string"}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dataset_id":{"type":"string"},"removed_count":{"type":"number"},"remaining_count":{"type":"number"},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/ignore":{"post":{"summary":"Hide Inlinks discoveries (no dataset write)","tags":["Inlinks"],"description":"Marks the given old_urls as ignored. Ignored rows are excluded from the Auto fix and Manual fix tabs and surface under the Ignored tab. Does not modify the dataset or push the config.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["old_urls"],"properties":{"old_urls":{"type":"array","minItems":1,"items":{"type":"string"}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ignored_count":{"type":"number"},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/unignore":{"post":{"summary":"Reintegrate previously-ignored Inlinks discoveries","tags":["Inlinks"],"description":"Clears the ignored flag on the given old_urls; rows return to their originating tab (auto_fix or manual_fix).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["old_urls"],"properties":{"old_urls":{"type":"array","minItems":1,"items":{"type":"string"}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"unignored_count":{"type":"number"},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/status":{"patch":{"summary":"Enable or disable the Inlinks app","tags":["Inlinks"],"description":"Toggles the system-managed inlinks SEO recommendation on/off without touching its dataset. Disabling it makes the engine stop preloading the inlinks map, equivalent to turning the app off. No-op when no recommendation has been provisioned yet (i.e. nothing has ever been fixed).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the system-managed Inlinks recommendation should be enabled"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"recommendation_uuid":{"type":"string","nullable":true},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/csr":{"patch":{"summary":"Enable or disable CSR re-injection for the Inlinks app","tags":["Inlinks"],"description":"Toggles the `csr` flag on the system-managed inlinks SEO recommendation. When on, the engine re-applies inlink href rewrites client-side after hydration (for sites using a CSR framework). No-op when no recommendation has been provisioned yet (i.e. nothing has ever been fixed).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["csr"],"properties":{"csr":{"type":"boolean","description":"Whether CSR re-injection should be enabled on the Inlinks recommendation"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:write","app-inlinks:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"type":"boolean"},"recommendation_uuid":{"type":"string","nullable":true},"applied_at":{"type":"string"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"422":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/stats":{"get":{"summary":"Get Inlinks aggregated stats","tags":["Inlinks"],"description":"Returns total, per-bucket counts (auto_fix/manual_fix/fixed/ignored), 7-day hits and coverage percentage for the config.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","description":"Total of all kind of inlinks combined"},"auto_fix_count":{"type":"number","description":"Number of inlinks that can be fixed automatically (i.e. where we know a valid replacement)"},"manual_fix_count":{"type":"number","description":"Number of inlinks that should be manually fixed (i.e. where we don't know a valid replacement)"},"fixed_count":{"type":"number","description":"Number of already fixed inlinks"},"fixed_auto_count":{"type":"number","description":"Fixed inlinks whose crawl-resolved destination was applied"},"fixed_manual_count":{"type":"number","description":"Fixed inlinks whose destination was entered by the user"},"ignored_count":{"type":"number","description":"Number of ignored inlinks"},"last_aggregated_at":{"type":"string","description":"Results aggregation date (hourly)"},"enabled":{"type":"boolean","description":"Whether the system-managed fix-inlinks recommendation exists and is enabled"},"csr":{"type":"boolean","description":"Whether CSR re-injection is enabled on the system-managed fix-inlinks recommendation"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/stats/links-to-fix":{"get":{"summary":"Get Inlinks \"links to fix\" time series","tags":["Inlinks"],"description":"Returns the 30-day daily series of distinct treatable inlinks (auto ∪ manual) with indicator value and trend.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number"},"trend":{"type":"number"},"series":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"value":{"type":"number"}}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/stats/broken-chains":{"get":{"summary":"Get Inlinks broken-chains time series","tags":["Inlinks"],"description":"Returns the per-crawl series of broken + looping redirect chains (broken_count + loops_count) with indicator value and trend.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number"},"trend":{"type":"number"},"series":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"value":{"type":"number"}}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/stats/coverage":{"get":{"summary":"Get Inlinks coverage ratio","tags":["Inlinks"],"description":"Returns the coverage ratio (0-100): fixed links over treatable + fixed. No time series yet.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/discoveries":{"get":{"summary":"List Inlinks discoveries","tags":["Inlinks"],"description":"Returns a paginated list of discovered inlinks items, filterable by status and URL substring.","parameters":[{"schema":{"type":"string","enum":["auto_fix","manual_fix","fixed_auto","fixed_manual","ignored","fixed","dead_link"],"default":"auto_fix"},"in":"query","name":"filter","required":false,"description":"Filter by fix status"},{"schema":{"type":"string"},"in":"query","name":"href_contains","required":false,"description":"Filter by URL substring (old_url or new_url)"},{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":25},"in":"query","name":"page_size","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"old_url":{"type":"string"},"new_url":{"type":"string","nullable":true},"referrer_count":{"type":"number"},"detected_at":{"type":"string","nullable":true},"status_chain":{"type":"string","nullable":true},"hops":{"type":"number"},"fixed_at":{"type":"string","nullable":true},"ignored_at":{"type":"string","nullable":true}}}},"total":{"type":"number"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/discoveries/export":{"get":{"summary":"Export Inlinks discoveries as CSV","tags":["Inlinks"],"description":"Downloads all matching inlinks discoveries as a CSV file.","parameters":[{"schema":{"type":"string","enum":["all","auto_fix","manual_fix","fixed","fixed_auto","fixed_manual","ignored"],"default":"all"},"in":"query","name":"filter","required":false,"description":"Filter by fix status, or \"all\" (default) to export every status in one file"},{"schema":{"type":"string"},"in":"query","name":"href_contains","required":false,"description":"Filter by URL substring (old_url or new_url)"},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/inlinks/discoveries/referrers":{"get":{"summary":"List internal referrers of a 3xx target (maillage drill-down)","tags":["Inlinks"],"description":"Returns the internal pages (source_url, anchor_text, nofollow) that link to the given 3xx target_url, scoped to the latest completed crawl. Paginated.","parameters":[{"schema":{"type":"string"},"in":"query","name":"target_url","required":true,"description":"The 3xx target URL whose internal referrers to list"},{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"page_size","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-inlinks:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"source_url":{"type":"string"},"anchor_text":{"type":"string"},"nofollow":{"type":"boolean"}}}},"total":{"type":"number"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/assessment":{"get":{"summary":"Get the SEO Metadata assessment","tags":["SEO Metadata"],"description":"Returns the read-only metadata health assessment for a config: per-control counts grouped by category (title, description, h1, canonical, robots, hreflang, alt, http), the derived health score with its breakdown, the page-status distribution and the declared languages.","parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pagesAnalyzed":{"type":"number","description":"Total pages analysed in the catalogue"},"pagesWithDefect":{"type":"number","description":"Pages with at least one metadata defect"},"declaredLanguages":{"type":"array","items":{"type":"string"},"description":"Declared hreflang languages/regions"},"lastAggregatedAt":{"type":"string","description":"Results aggregation date (ISO)"},"score":{"type":"number","description":"Health score (0-100)"},"scoreTrend30d":{"type":"number","description":"Score delta (points) vs the previous crawl, despite the name"},"previousAggregatedAt":{"type":"string","description":"Start of the previous crawl the deltas compare to (ISO), null when there is none","nullable":true},"distribution":{"type":"object","description":"Page-status distribution over the analysed catalogue","properties":{"healthy":{"type":"number"},"watch":{"type":"number"},"critical":{"type":"number"}}},"controls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string","enum":["title","description","h1","canonical","robots","hreflang","alt","http"]},"label":{"type":"string"},"question":{"type":"string"},"severity":{"type":"string","enum":["critique","eleve","moyen","indicateur"]},"count":{"type":"number"},"unit":{"type":"string","enum":["pages","images","percent","languages"]},"cataloguePct":{"type":"number","nullable":true},"penalty":{"type":"number"},"previousCount":{"type":"number","description":"Same count on the previous crawl, null when there is none","nullable":true},"breakdown":{"type":"object","description":"Too short vs too long, on the *_length controls only","properties":{"tooShort":{"type":"number"},"tooLong":{"type":"number"}}}}}},"scoreBreakdown":{"type":"object","properties":{"totalPenalty":{"type":"number"},"severityWeights":{"type":"object","properties":{"critique":{"type":"number"},"eleve":{"type":"number"},"moyen":{"type":"number"},"indicateur":{"type":"number"}}},"categoryCoefficients":{"type":"object","properties":{"title":{"type":"number"},"description":{"type":"number"},"h1":{"type":"number"},"canonical":{"type":"number"},"robots":{"type":"number"},"hreflang":{"type":"number"},"alt":{"type":"number"},"http":{"type":"number"}}},"topFactors":{"type":"array","items":{"type":"object","properties":{"controlId":{"type":"string"},"label":{"type":"string"},"category":{"type":"string","enum":["title","description","h1","canonical","robots","hreflang","alt","http"]},"severity":{"type":"string","enum":["critique","eleve","moyen","indicateur"]},"penalty":{"type":"number"}}}},"failingControls":{"type":"number"},"criticalControls":{"type":"number"}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/urls":{"get":{"summary":"List crawled URLs with per-URL defect counts","tags":["SEO Metadata"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"url_contains","required":false},{"schema":{"type":"string"},"in":"query","name":"page_type","required":false},{"schema":{"type":"string","enum":["2xx","3xx","4xx","5xx"]},"in":"query","name":"status_class","required":false},{"schema":{"type":"integer","minimum":0,"maximum":599},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"query","name":"control","required":false},{"schema":{"type":"string","enum":["title","description","h1","canonical","robots","hreflang","alt","http"]},"in":"query","name":"category","required":false},{"schema":{"type":"string","enum":["short","long"]},"in":"query","name":"length","required":false},{"schema":{"type":"string","enum":["severity","problems","url","status","page_type","inbound_links"],"default":"severity"},"in":"query","name":"sort","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"order","required":false},{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":25},"in":"query","name":"page_size","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"pageType":{"type":"string"},"status":{"type":"number"},"redirectLocation":{"type":"string"},"problemsTotal":{"type":"number"},"severityCounts":{"type":"object","properties":{"critique":{"type":"number"},"eleve":{"type":"number"},"moyen":{"type":"number"}}},"inboundLinks":{"type":"number","description":"Links pointing to this URL in the crawl"}}}},"total":{"type":"number"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/urls/export":{"get":{"summary":"Export the filtered URL list as CSV","tags":["SEO Metadata"],"description":"Same filters as the URL list, without pagination. Returns a text/csv attachment.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url_contains","required":false},{"schema":{"type":"string"},"in":"query","name":"page_type","required":false},{"schema":{"type":"string","enum":["2xx","3xx","4xx","5xx"]},"in":"query","name":"status_class","required":false},{"schema":{"type":"integer","minimum":0,"maximum":599},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"query","name":"control","required":false},{"schema":{"type":"string","enum":["title","description","h1","canonical","robots","hreflang","alt","http"]},"in":"query","name":"category","required":false},{"schema":{"type":"string","enum":["short","long"]},"in":"query","name":"length","required":false},{"schema":{"type":"string","enum":["severity","problems","url","status","page_type","inbound_links"],"default":"severity"},"in":"query","name":"sort","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"order","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/urls/facets":{"get":{"summary":"List available page types for the latest crawl","tags":["SEO Metadata"],"parameters":[{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pageTypes":{"type":"array","items":{"type":"string"}},"pageTypeSource":{"type":"string","enum":["crawl","path"],"description":"'path' when the crawl typed no page: page types are then the first URL path segment"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/duplicates":{"get":{"summary":"List groups of pages sharing a title or a meta description","tags":["SEO Metadata"],"description":"One row per shared value on the latest crawl (compared case- and whitespace-insensitively), largest groups first, with a sample of the pages in each.","parameters":[{"schema":{"type":"string","enum":["title","description"]},"in":"query","name":"field","required":true},{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"in":"query","name":"page_size","required":false},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The shared value, as one of the pages spells it"},"pages":{"type":"number"},"urls":{"type":"array","items":{"type":"string"},"description":"Sample of the pages, capped at 100"}}}},"total":{"type":"number","description":"Number of groups"}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{id}/apps/seo-metadata/urls/detail":{"get":{"summary":"Get the full per-URL SEO detail","tags":["SEO Metadata"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"url","required":true},{"schema":{"type":"string","minLength":1},"example":"1234","in":"path","name":"id","required":true,"description":"Configuration ID"}],"security":[{"Secret API key":[],"JWT":["application:read","app-seo-metadata:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","properties":{"url":{"type":"string"},"pageType":{"type":"string"},"status":{"type":"number"},"title":{"type":"string"},"titleLength":{"type":"number"},"metaDescription":{"type":"string"},"descriptionLength":{"type":"number"},"canonicalHref":{"type":"string"},"robotsNoindex":{"type":"boolean"},"robotsNofollow":{"type":"boolean"},"htmlLang":{"type":"string"},"h1":{"type":"array","items":{"type":"string"}},"imagesTotal":{"type":"number"},"imagesMissingAlt":{"type":"number"},"hreflangLangs":{"type":"array","items":{"type":"string"}},"ldJsonTypes":{"type":"array","items":{"type":"string"}}}},"controls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string","enum":["title","description","h1","canonical","robots","hreflang","alt","http"]},"severity":{"type":"string","enum":["critique","eleve","moyen","indicateur"]},"status":{"type":"string","enum":["pass","fail"]}}}},"redirectChain":{"type":"object","properties":{"status":{"type":"number"},"redirectLocation":{"type":"string"},"finalUrl":{"type":"string"},"chainLength":{"type":"number"},"chainStatus":{"type":"string"},"depth":{"type":"number"},"discoveredFrom":{"type":"string"},"responseTimeMs":{"type":"number"}},"nullable":true},"inboundLinks":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"sourceUrl":{"type":"string"},"anchorText":{"type":"string"},"nofollow":{"type":"boolean"}}}},"total":{"type":"number"}}}}}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}},"503":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"number"},"columnIndex":{"type":"number"},"message":{"type":"string"},"path":{"type":"string"}}}}},"required":["statusCode","error","message"]}}}}}}},"/v2/configs/{configId}/seo-recommendations/{recommendationId}/css-selector-status":{"get":{"summary":"Get CSS selector status for a SEO recommendation","tags":["SEO Recommendations"],"description":"Returns the latest CSS selector analysis results for a specific SEO recommendation","parameters":[{"schema":{"type":"string"},"in":"path","name":"configId","required":true,"description":"The config ID of the website"},{"schema":{"type":"string"},"in":"path","name":"recommendationId","required":true,"description":"The UUID of the SEO recommendation"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The URL that was tested"},"sourceType":{"type":"string","description":"The source type (e.g., seo-recommendation, api-connector)"},"sourceId":{"type":"string","description":"The source ID (e.g., recommendation ID)"},"configId":{"type":"string","description":"The config ID"},"checkedAt":{"type":"string","format":"date-time"},"totalSelectors":{"type":"integer"},"validSelectors":{"type":"integer"},"invalidSelectors":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"selector":{"type":"string"},"sourceKey":{"type":"string","description":"Key within the source (e.g., recipe:update-heading-tag)"},"isValid":{"type":"boolean"},"elementCount":{"type":"integer"},"errorCode":{"type":"string","description":"Machine-readable error code for i18n"},"errorMessage":{"type":"string"}}}}}}}}}}}},"/v2/configs/{configId}/css-selector-status":{"get":{"summary":"Get CSS selector status for a config","tags":["CSS Selector Analysis"],"description":"Returns the latest CSS selector analysis results for all sources in a config","parameters":[{"schema":{"type":"string"},"in":"path","name":"configId","required":true,"description":"The config ID of the website"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"configId":{"type":"string"},"checkedAt":{"type":"string","format":"date-time"},"totalSelectors":{"type":"integer"},"validSelectors":{"type":"integer"},"invalidSelectors":{"type":"integer"},"sourceResults":{"type":"array","items":{"type":"object","properties":{"sourceType":{"type":"string"},"sourceId":{"type":"string"},"url":{"type":"string"},"totalSelectors":{"type":"integer"},"validSelectors":{"type":"integer"},"invalidSelectors":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"selector":{"type":"string"},"sourceKey":{"type":"string"},"isValid":{"type":"boolean"},"elementCount":{"type":"integer"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}}}}}}}}}}}}}},"/v2/configs/{configId}/css-selector-status/data":{"get":{"summary":"Get config data for CSS selector analysis","tags":["CSS Selector Analysis"],"description":"Returns all CSS selector sources with their URLs and selectors. Called by the serverless job to get the data it needs.","parameters":[{"schema":{"type":"string"},"in":"path","name":"configId","required":true,"description":"The config ID of the website"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["sources"],"properties":{"sources":{"type":"array","items":{"type":"object","required":["sourceType","sourceId","sourceName","url","selectors"],"properties":{"sourceType":{"type":"string","description":"The source type (e.g., seo-recommendation)"},"sourceId":{"type":"string","description":"The source ID (e.g., recommendation ID)"},"sourceName":{"type":"string","description":"Human-readable name of the source"},"url":{"type":"string","description":"The URL to analyze for this source"},"selectors":{"type":"array","items":{"type":"object","required":["selector"],"properties":{"selector":{"type":"string","description":"The CSS selector to test"},"sourceKey":{"type":"string","description":"Key within the source (e.g., recipe:update-heading-tag)"}}}}}}}}}}}}}}},"/v2/css-selector-status/send-pending-reports":{"post":{"summary":"Send pending CSS selector report emails","tags":["CSS Selector Analysis"],"description":"Sends aggregated CSS selector report emails for all pending reports. Each user receives a single email covering all their websites. Called by a scheduled job after all per-config analysis jobs have completed.","responses":{}}},"/v2/configs/{configId}/css-selector-status/report":{"post":{"summary":"Receive CSS selector analysis report from the serverless job","tags":["CSS Selector Analysis"],"description":"Receives and stores the analysis results from the serverless job. Called after the job completes the analysis for the entire config.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["checkedAt","sourceResults"],"properties":{"checkedAt":{"type":"string","format":"date-time","description":"When the analysis was performed"},"sourceResults":{"type":"array","items":{"type":"object","required":["sourceType","sourceId","url","results"],"properties":{"sourceType":{"type":"string","description":"The source type (e.g., seo-recommendation)"},"sourceId":{"type":"string","description":"The source ID (e.g., recommendation ID)"},"url":{"type":"string","description":"The URL that was analyzed"},"results":{"type":"array","items":{"type":"object","required":["selector","isValid","elementCount"],"properties":{"selector":{"type":"string","description":"The CSS selector that was tested"},"sourceKey":{"type":"string","description":"Key within the source (e.g., recipe:update-heading-tag)"},"isValid":{"type":"boolean","description":"Whether the selector matched any elements"},"elementCount":{"type":"integer","description":"Number of elements matched"},"errorMessage":{"type":"string","description":"Error message if the selector is invalid"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"configId","required":true,"description":"The config ID of the website"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"configId":{"type":"string"},"checkedAt":{"type":"string","format":"date-time"},"totalSelectors":{"type":"integer"},"validSelectors":{"type":"integer"},"invalidSelectors":{"type":"integer"},"sourceResults":{"type":"array","items":{"type":"object","properties":{"sourceType":{"type":"string"},"sourceId":{"type":"string"},"url":{"type":"string"},"totalSelectors":{"type":"integer"},"validSelectors":{"type":"integer"},"invalidSelectors":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"selector":{"type":"string"},"sourceKey":{"type":"string"},"isValid":{"type":"boolean"},"elementCount":{"type":"integer"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}}}}}}}}}}}}}},"/v2/configs/{id}/entities":{"get":{"summary":"List config entities for a config","tags":["Config Entity Subscription"],"description":"Returns all config entities for a given config, optionally filtered by type","parameters":[{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"Filter by entity type (e.g. seo-recommendation)"},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The config ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{}}},"/v2/config-entities/{uuid}/subscriptions":{"get":{"summary":"Get subscriptions for a config entity","tags":["Config Entity Subscription"],"description":"Returns the list of user IDs that are subscribed to alerts for a specific config entity","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"uuid","required":true,"description":"The UUID of the config entity"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:read","app-apiconnector:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"integer"},"description":"Array of subscriber user IDs"}}}}}}}},"put":{"summary":"Set subscriptions for a config entity","tags":["Config Entity Subscription"],"description":"Replaces all existing subscriptions with the provided list of user IDs","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userIds"],"properties":{"userIds":{"type":"array","items":{"type":"integer"},"description":"Array of user IDs to set as subscribers"}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"uuid","required":true,"description":"The UUID of the config entity"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:write","app-apiconnector:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"integer"},"description":"Array of subscriber user IDs"}}}}}}}},"post":{"summary":"Add a subscription to a config entity","tags":["Config Entity Subscription"],"description":"Adds a user as a subscriber to alerts for a specific config entity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"integer","description":"User ID to add as a subscriber"}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"uuid","required":true,"description":"The UUID of the config entity"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:write","app-apiconnector:write"]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}}}},"/v2/config-entities/{uuid}/subscriptions/{userId}":{"delete":{"summary":"Remove a subscription from a config entity","tags":["Config Entity Subscription"],"description":"Removes a user from the subscriptions list for a specific config entity","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"uuid","required":true,"description":"The UUID of the config entity"},{"schema":{"type":"string"},"in":"path","name":"userId","required":true,"description":"User ID to remove from subscribers"}],"security":[{"Secret API key":[],"JWT":["app-seo-recommendation:write","app-apiconnector:write"]}],"responses":{}}},"/v2/notifications":{"get":{"summary":"List notifications for the authenticated user","tags":["Notification"],"description":"Returns a paginated list of notifications for the currently authenticated user","parameters":[{"schema":{"type":"number","minimum":1},"in":"query","name":"page","required":false,"description":"Page number (default: 1)"},{"schema":{"type":"number","minimum":1},"in":"query","name":"limit","required":false,"description":"Items per page (default: 20)"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"unreadOnly","required":false,"description":"Filter to unread only"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"userId":{"type":"number"},"type":{"type":"string"},"title":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true,"nullable":true},"isRead":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"/v2/notifications/unread-count":{"get":{"summary":"Get unread notification count","tags":["Notification"],"description":"Returns the number of unread notifications for the currently authenticated user","security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number"}}}}}}}}},"/v2/notifications/{id}/read":{"patch":{"summary":"Mark a notification as read","tags":["Notification"],"description":"Marks a specific notification as read for the currently authenticated user","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Notification ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/notifications/read-all":{"patch":{"summary":"Mark all notifications as read","tags":["Notification"],"description":"Marks all notifications as read for the currently authenticated user","security":[{"Secret API key":[],"JWT":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/organizations/{organizationId}/ai/conversations":{"post":{"summary":"Create an AI conversation","tags":["AI Conversation"],"description":"Creates a new EdgeAI conversation for the authenticated user, optionally scoped to a website","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["origin"],"additionalProperties":false,"properties":{"configId":{"type":"string","minLength":1,"maxLength":255,"description":"Website scope (omit for general)"},"origin":{"type":"string","enum":["page","widget"],"description":"Where the conversation was started"}}}}}},"parameters":[{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"number"},"organizationId":{"type":"number"},"configId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"origin":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"get":{"summary":"List AI conversations","tags":["AI Conversation"],"description":"Returns the authenticated user own EdgeAI conversations for the organization","parameters":[{"schema":{"type":"number","minimum":1},"in":"query","name":"page","required":false,"description":"Page number (default: 1)"},{"schema":{"type":"number","minimum":1,"maximum":100},"in":"query","name":"limit","required":false,"description":"Items per page (default: 20)"},{"schema":{"type":"string"},"in":"query","name":"configId","required":false,"description":"Filter by website scope"},{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"number"},"organizationId":{"type":"number"},"configId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"origin":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}}},"/v2/organizations/{organizationId}/ai/conversations/{id}":{"get":{"summary":"Get an AI conversation with its messages","tags":["AI Conversation"],"description":"Returns a conversation owned by the authenticated user, including its ordered messages","parameters":[{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":36,"maxLength":36},"in":"path","name":"id","required":true,"description":"Conversation UUID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"number"},"organizationId":{"type":"number"},"configId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"origin":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"conversationId":{"type":"string"},"messageId":{"type":"string"},"role":{"type":"string"},"parts":{"type":"array","items":{"type":"object","additionalProperties":true}},"metadata":{"type":"object","additionalProperties":true,"nullable":true},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}}},"patch":{"summary":"Rename an AI conversation","tags":["AI Conversation"],"description":"Renames a conversation owned by the authenticated user","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"maxLength":255,"description":"New conversation title"}}}}}},"parameters":[{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":36,"maxLength":36},"in":"path","name":"id","required":true,"description":"Conversation UUID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"number"},"organizationId":{"type":"number"},"configId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"origin":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"delete":{"summary":"Delete an AI conversation","tags":["AI Conversation"],"description":"Deletes a conversation owned by the authenticated user and all its messages","parameters":[{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":36,"maxLength":36},"in":"path","name":"id","required":true,"description":"Conversation UUID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/organizations/{organizationId}/ai/conversations/{id}/messages":{"post":{"summary":"Upsert AI conversation messages","tags":["AI Conversation"],"description":"Idempotently appends or updates a batch of UIMessages (keyed by messageId); called by fasterize-agent at end of turn","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["messages"],"additionalProperties":false,"properties":{"messages":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","required":["messageId","role","parts"],"additionalProperties":false,"properties":{"messageId":{"type":"string","minLength":1,"maxLength":255,"description":"AI SDK UIMessage id"},"role":{"type":"string","enum":["user","assistant","system"],"description":"Message author role"},"parts":{"type":"array","description":"UIMessage parts array"},"metadata":{"type":"object","additionalProperties":true,"description":"Model, token usage, etc."}}}}}}}}},"parameters":[{"schema":{"type":"number"},"in":"path","name":"organizationId","required":true,"description":"Organization ID"},{"schema":{"type":"string","minLength":36,"maxLength":36},"in":"path","name":"id","required":true,"description":"Conversation UUID"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/websites/{websiteId}/google-search-console/oauth-url":{"get":{"summary":"Build the Google Search Console OAuth authorize URL for the given website","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"query","name":"projectId","required":true,"description":"Dashboard project ID (numeric), used to build the post-OAuth redirect URL"},{"schema":{"type":"string","enum":["dashboard","consol3"]},"in":"query","name":"client","required":false,"description":"Which app starts the flow — selects the Google-registered redirect URI (default: dashboard)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"authorizeUrl":{"type":"string"},"nonce":{"type":"string","description":"To store in a browser cookie; the callback requires it to match"}}}}}}}}},"/v2/google-search-console/oauth/callback":{"post":{"summary":"Complete the Search Console OAuth flow (called by the dashboard callback route)","tags":["Google Search Console"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"state":{"type":"string"},"error":{"type":"string"},"error_description":{"type":"string"},"nonce":{"type":"string","description":"The browser's gsc_oauth_nonce cookie, set when the flow started"}}}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["success","error"]},"websiteId":{"type":"number","nullable":true},"projectId":{"type":"number","nullable":true},"error":{"type":"string"}}}}}}}}},"/v2/websites/{websiteId}/google-search-console":{"get":{"summary":"Get the Google Search Console connection status for a website","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"connected":{"type":"boolean"},"siteUrl":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true,"description":"Canonical ClickHouse domain key derived from siteUrl"},"scope":{"type":"string","nullable":true},"connectedAt":{"type":"string","format":"date-time","nullable":true},"connectedByUserId":{"type":"number","nullable":true}}}}}}}},"delete":{"summary":"Disconnect Google Search Console for this website","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/websites/{websiteId}/google-search-console/sites":{"get":{"summary":"List Search Console properties the connected user has access to","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sites":{"type":"array","items":{"type":"object","properties":{"siteUrl":{"type":"string"},"permissionLevel":{"type":"string"}}}}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/site":{"put":{"summary":"Select the Search Console property to use for this website","tags":["Google Search Console"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["siteUrl"],"properties":{"siteUrl":{"type":"string","description":"Google Search Console site URL (e.g. sc-domain:example.com)"}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:write"]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v2/websites/{websiteId}/google-search-console/recommendations":{"get":{"summary":"List the website SEO recommendations (uuid + name) for the metrics filter","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendations":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"appliedAt":{"type":"string","format":"date-time","nullable":true}}}}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/clickhouse-ca":{"get":{"summary":"ClickHouse TLS CA certificate the importer trusts to reach the Data Warehouse","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"caCert":{"type":"string","nullable":true}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/import-range":{"get":{"summary":"How far back to backfill a website (6 months, or a week before its first SEO recommendation if older; max ~16 months)","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"backfillStartDate":{"type":"string","nullable":true}}}}}}}}},"/v2/google-search-console/connected-websites":{"get":{"summary":"List websites with a selected Search Console property (importer fan-out work-list)","tags":["Google Search Console"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"websites":{"type":"array","items":{"type":"object","properties":{"websiteId":{"type":"number"},"siteUrl":{"type":"string"},"domain":{"type":"string"}},"required":["websiteId","siteUrl","domain"]}}}}}}}}}},"/internal/google-search-console/enqueue-imports":{"post":{"summary":"Enqueue a GSC import task per connected website (called by the daily CronJob)","tags":["Google Search Console"],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enqueued":{"type":"number"}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/metrics/timeseries":{"get":{"summary":"Search Console metrics per day for the selected period","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"startDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"endDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","enum":["web","image","video","news","discover","googleNews"]},"in":"query","name":"searchType","required":false},{"schema":{"type":"string"},"in":"query","name":"recommendationUuid","required":false,"description":"Restrict to the URLs targeted by this SEO recommendation"},{"schema":{"type":"string"},"in":"query","name":"filters","required":false,"description":"JSON array of page/query filters"},{"schema":{"type":"string","enum":["and","or"]},"in":"query","name":"filterMode","required":false,"description":"How the filters combine: all must match (and, default) or any (or)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"siteUrl":{"type":"string"},"total":{"type":"number","nullable":true},"truncatedTargeting":{"type":"boolean","description":"True when the selected recommendation's URL dataset exceeds 50 000 entries: metrics cover its first 50 000"},"rows":{"type":"array","items":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"clicks":{"type":"number"},"impressions":{"type":"number"},"ctr":{"type":"number"},"position":{"type":"number"}}}}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/metrics/pages":{"get":{"summary":"Search Console metrics aggregated by page for the selected period","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"startDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"endDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","enum":["web","image","video","news","discover","googleNews"]},"in":"query","name":"searchType","required":false},{"schema":{"type":"string"},"in":"query","name":"recommendationUuid","required":false,"description":"Restrict to the URLs targeted by this SEO recommendation"},{"schema":{"type":"string"},"in":"query","name":"filters","required":false,"description":"JSON array of page/query filters"},{"schema":{"type":"string","enum":["and","or"]},"in":"query","name":"filterMode","required":false,"description":"How the filters combine: all must match (and, default) or any (or)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"query","name":"startRow","required":false,"description":"Pagination offset (numeric)"},{"schema":{"type":"integer","minimum":1,"maximum":25000},"in":"query","name":"rowLimit","required":false,"description":"Max rows (default 100)"},{"schema":{"type":"string","enum":["key","clicks","impressions","ctr","position"]},"in":"query","name":"orderBy","required":false,"description":"Sort column for the dimension breakdown"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderDir","required":false,"description":"Sort direction (asc/desc)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"siteUrl":{"type":"string"},"total":{"type":"number","nullable":true},"truncatedTargeting":{"type":"boolean","description":"True when the selected recommendation's URL dataset exceeds 50 000 entries: metrics cover its first 50 000"},"rows":{"type":"array","items":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"clicks":{"type":"number"},"impressions":{"type":"number"},"ctr":{"type":"number"},"position":{"type":"number"}}}}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/metrics/queries":{"get":{"summary":"Search Console metrics aggregated by query for the selected period","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"startDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"endDate","required":false,"description":"YYYY-MM-DD"},{"schema":{"type":"string","enum":["web","image","video","news","discover","googleNews"]},"in":"query","name":"searchType","required":false},{"schema":{"type":"string"},"in":"query","name":"recommendationUuid","required":false,"description":"Restrict to the URLs targeted by this SEO recommendation"},{"schema":{"type":"string"},"in":"query","name":"filters","required":false,"description":"JSON array of page/query filters"},{"schema":{"type":"string","enum":["and","or"]},"in":"query","name":"filterMode","required":false,"description":"How the filters combine: all must match (and, default) or any (or)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"query","name":"startRow","required":false,"description":"Pagination offset (numeric)"},{"schema":{"type":"integer","minimum":1,"maximum":25000},"in":"query","name":"rowLimit","required":false,"description":"Max rows (default 100)"},{"schema":{"type":"string","enum":["key","clicks","impressions","ctr","position"]},"in":"query","name":"orderBy","required":false,"description":"Sort column for the dimension breakdown"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderDir","required":false,"description":"Sort direction (asc/desc)"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"siteUrl":{"type":"string"},"total":{"type":"number","nullable":true},"truncatedTargeting":{"type":"boolean","description":"True when the selected recommendation's URL dataset exceeds 50 000 entries: metrics cover its first 50 000"},"rows":{"type":"array","items":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"clicks":{"type":"number"},"impressions":{"type":"number"},"ctr":{"type":"number"},"position":{"type":"number"}}}}}}}}}}}},"/v2/websites/{websiteId}/google-search-console/access-token":{"get":{"summary":"Short-lived Google access token for the importer (refresh tokens never leave the API)","tags":["Google Search Console"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"siteUrl":{"type":"string"}}}}}}}}},"/v2/websites/{websiteId}/cdn-logs-collection":{"get":{"summary":"Whether the CDN logs of the website domain are collected into the data warehouse","tags":["CDN logs collection"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["domain","enabled","enabled_at","lock","activity"],"properties":{"domain":{"type":"string","description":"Website domain, as matched against the CDN log host"},"enabled":{"type":"boolean","description":"Whether new CDN logs of the domain are kept. Independent from whether the website is analysed."},"enabled_at":{"type":"string","format":"date-time","nullable":true,"description":"When collection was first enabled for the domain, null when disabled"},"lock":{"type":"string","enum":["wildcard_rule","non_canonical_domain"],"nullable":true,"description":"Why collection cannot be changed through the API: wildcard_rule (a wildcard whitelist row covers the domain, handled by Fasterize), non_canonical_domain (the domain has upper case or a trailing dot). Null when it can."},"activity":{"type":"object","nullable":true,"required":["last_log_at","lookback_hours"],"description":"Latest CDN log line received for the domain: the last hour of all logs, collected or not, then the collected logs of the lookback. Null when it could not be read.","properties":{"last_log_at":{"type":"string","format":"date-time","nullable":true,"description":"Null when no log line arrived within the lookback"},"lookback_hours":{"type":"number","description":"How far back last_log_at is searched"}}}}}}}}}},"put":{"summary":"Enable or disable the collection of the CDN logs of the website domain","tags":["CDN logs collection"],"description":"Idempotent. Takes effect on the next log batch, without backfill: disabling keeps the history until its retention. Does not change whether the website is analysed: its log-based metrics become unmeasured.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"additionalProperties":false,"properties":{"enabled":{"type":"boolean","description":"Whether the CDN logs of the website domain are collected"}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:write"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["domain","enabled","enabled_at","lock","activity"],"properties":{"domain":{"type":"string","description":"Website domain, as matched against the CDN log host"},"enabled":{"type":"boolean","description":"Whether new CDN logs of the domain are kept. Independent from whether the website is analysed."},"enabled_at":{"type":"string","format":"date-time","nullable":true,"description":"When collection was first enabled for the domain, null when disabled"},"lock":{"type":"string","enum":["wildcard_rule","non_canonical_domain"],"nullable":true,"description":"Why collection cannot be changed through the API: wildcard_rule (a wildcard whitelist row covers the domain, handled by Fasterize), non_canonical_domain (the domain has upper case or a trailing dot). Null when it can."},"activity":{"type":"object","nullable":true,"required":["last_log_at","lookback_hours"],"description":"Latest CDN log line received for the domain: the last hour of all logs, collected or not, then the collected logs of the lookback. Null when it could not be read.","properties":{"last_log_at":{"type":"string","format":"date-time","nullable":true,"description":"Null when no log line arrived within the lookback"},"lookback_hours":{"type":"number","description":"How far back last_log_at is searched"}}}}}}}},"409":{"description":"CDN logs collection cannot be changed for this website (reason: wildcard_rule, non_canonical_domain).","content":{"application/json":{"schema":{"type":"object","description":"CDN logs collection cannot be changed for this website (reason: wildcard_rule, non_canonical_domain).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The change could not be confirmed by reading the whitelist back, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The change could not be confirmed by reading the whitelist back, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/fields":{"get":{"summary":"Fields of the traffic explorer, by section, with what each one supports","tags":["Traffic explorer"],"description":"Field and value ids only, the console owns every label. A field the logs do not carry yet is listed as unavailable and refused in filters. Served for websites served by Cloudflare only.","parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["retention","sections"],"properties":{"retention":{"type":"object","required":["from"],"properties":{"from":{"type":"string","format":"date-time","description":"Start of the oldest day of logs kept"}}},"sections":{"type":"array","items":{"type":"object","required":["id","fields"],"properties":{"id":{"type":"string","enum":["request","response","visitor","fasterize","security"]},"fields":{"type":"array","items":{"type":"object","required":["id","type","filterable","operators","groupable","available"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datetime","string","string_list","integer","number","ip","boolean"]},"filterable":{"type":"boolean"},"operators":{"type":"array","items":{"type":"string","enum":["include","exclude","gte","lte"]},"description":"The operators a filter on the field takes, empty when it cannot be filtered: include and exclude on values, or on one flag each for fstrz_flags; gte and lte on a measure"},"groupable":{"type":"boolean"},"available":{"type":"boolean","description":"False while the logs do not carry the field: hidden, and refused in filters"},"values":{"type":"array","items":{"type":"string"},"description":"Known value ids. A derived field accepts only these; visitor, device, cache, block_reason may carry others, which stay filterable and show up in facets"},"max_value_length":{"type":"integer","description":"Longest value an exact filter on this field can match"}}}}}}}}}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/requests/search":{"post":{"summary":"Most recent requests served for a website, filtered and searched, with their exact total","tags":["Traffic explorer"],"description":"Read only. The 200 most recent matching requests, newest first, up to 50 at a time between the ranks _start and _end, with the exact total. Platform loop-back hops are never listed nor counted. A request_id search covers the whole retention, whatever the period.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"integer","minimum":0,"maximum":199,"default":0},"in":"query","name":"_start","required":false,"description":"Rank of the first request returned, newest first"},{"schema":{"type":"integer","minimum":1,"maximum":200},"in":"query","name":"_end","required":false,"description":"Rank after the last request returned; at most 50 after _start, defaults to it"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["requests","total","total_is_exact","limit","period"],"properties":{"requests":{"type":"array","items":{"type":"object","description":"One request, keyed by field id. Derived fields carry value ids; the console owns every label.","required":["time","method","scheme","domain","url","referrer","status","status_group","response_time","size","content_type","resource","visitor","bot","bot_verified","device","ip_address","ip_reputation","country","asn","user_agent","cache","edge_location","fasterize_optimization","error_source","fstrz_flags","request_id","security_action","block_reason","security_rule","attack_score"],"properties":{"time":{"type":"string","format":"date-time","nullable":true},"method":{"type":"string","nullable":true},"scheme":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"referrer":{"type":"string","nullable":true},"status":{"type":"integer","nullable":true},"status_group":{"type":"string","nullable":true},"response_time":{"type":"number","nullable":true},"size":{"type":"integer","nullable":true},"content_type":{"type":"string","nullable":true},"resource":{"type":"string","nullable":true},"visitor":{"type":"string","nullable":true},"bot":{"type":"string","nullable":true},"bot_verified":{"type":"boolean","nullable":true},"device":{"type":"string","nullable":true},"ip_address":{"type":"string","nullable":true},"ip_reputation":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"asn":{"type":"integer","nullable":true},"user_agent":{"type":"string","nullable":true},"cache":{"type":"string","nullable":true},"edge_location":{"type":"string","nullable":true},"fasterize_optimization":{"type":"string","nullable":true},"error_source":{"type":"string","nullable":true},"fstrz_flags":{"type":"string","nullable":true},"request_id":{"type":"string","nullable":true},"security_action":{"type":"array","items":{"type":"string"}},"block_reason":{"type":"array","items":{"type":"string"}},"security_rule":{"type":"string","nullable":true},"attack_score":{"type":"integer","nullable":true}}}},"total":{"type":"integer","description":"Number of requests matching the view in the period; a floor of 10000 when total_is_exact is false"},"total_is_exact":{"type":"boolean","description":"False when the view counts more requests than total"},"limit":{"type":"integer","description":"How many of the most recent matching requests _start and _end can reach"},"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"description":"The period actually searched: the requested one, or the whole retention for a Request ID search, so an empty result reads as \"not found in the retention\""}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/requests/export":{"post":{"summary":"The requests the list can show, as a CSV or JSON file","tags":["Traffic explorer"],"description":"Read only. Takes the body of the request search and returns, in one file, the 200 most recent matching requests the list pages through, newest first, with every available field in the order of the fields route and its raw values. Dates are written on the clock of time_zone with its offset. CSV: one header row of field ids, a list joined in one cell. JSON: an array of objects. x-exported-count gives the requests in the file, x-total-count the total of the view, a floor when x-total-is-exact is false.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"string","enum":["csv","json"]},"in":"query","name":"format","required":true},{"schema":{"type":"string","maxLength":64,"default":"UTC"},"in":"query","name":"time_zone","required":false,"description":"IANA time zone the dates are written in, with its offset, e.g. Europe/Paris"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/facets/{fieldId}":{"post":{"summary":"Request counts per value of one filter field, in the view without the filters on that field","tags":["Traffic explorer"],"description":"Read only. Takes the body of the request search: the period, filters and search of the view. The filters on the requested field are left out, so ticking one of its values never hides the others; each count equals the total of the list filtered on that value alone. Platform loop-back hops are never counted.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"},{"schema":{"type":"string","maxLength":64},"in":"path","name":"fieldId","required":true,"description":"A field of the filter column: status_group, status, visitor, device, cache, resource, error_source, fasterize_optimization, block_reason"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["values","other_count","total","period"],"properties":{"values":{"type":"array","description":"Most requests first. Derived fields list every value id, visitor, device, cache, block_reason every known one, counted or not; raw fields add null for the requests without a value. A list field such as block_reason counts a request under each of its values, so its counts can add up to more than total","items":{"type":"object","required":["value","count"],"properties":{"value":{"description":"Value id, raw value, or null for no value","anyOf":[{"type":"string"},{"type":"integer"},{"type":"object","nullable":true,"enum":[null]}]},"count":{"type":"integer","description":"Requests of the view with this value, as the list filtered on it alone counts them"}}}},"other_count":{"type":"integer","description":"Requests no returned value covers: beyond the 200 values returned, or matching no value of a derived field (a status outside 100-599); 0 when values covers every request"},"total":{"type":"integer","description":"Exact number of requests of the view without the filters on this field"},"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"description":"The period actually counted: the requested one, or the whole retention for a Request ID search"}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/histogram":{"post":{"summary":"Requests and bytes per bar of the view, optionally split by a field, with the exact totals","tags":["Traffic explorer"],"description":"Read only. Takes the body of the request search. Every bar of the period is returned, 0 when empty, and the bars add up to the exact totals. Each count of a series equals the list filtered on that value over that bar. Platform loop-back hops are never counted.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"string","enum":["requests","bandwidth"],"default":"requests"},"in":"query","name":"metric","required":false,"description":"bandwidth also sums the response bytes, which costs about half again as much"},{"schema":{"type":"string","maxLength":64},"in":"query","name":"split_by","required":false,"description":"A field of the chart's Split by: status_group, cache, visitor, error_source, resource, fasterize_optimization; omit it for the totals only. A field the logs do not carry yet, such as visitor, answers 400 field_unavailable"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["metric","interval_ms","period","total","buckets","split_by","series","other"],"properties":{"metric":{"type":"string","enum":["requests","bandwidth"],"description":"bytes are null unless bandwidth; a bandwidth answer also carries the requests"},"interval_ms":{"type":"integer","description":"Width of a bar; the first and last ones are cut by the period and may be shorter"},"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"description":"The period drawn: the requested one, or the whole retention for a Request ID search"},"total":{"type":"object","required":["requests","bytes"],"properties":{"requests":{"type":"integer"},"bytes":{"type":"integer","description":"Response bytes, for the bandwidth metric only","nullable":true}},"description":"Exact totals of the view, unlike the request list"},"buckets":{"type":"array","description":"Every bar from the period start, 0 when empty; they add up to total. Times are UTC. A bar covers [from, to): the list shows its requests with a period ending 1 ms before to, the last bar including the period end","items":{"type":"object","required":["from","to","requests","bytes"],"properties":{"from":{"type":"string","format":"date-time","description":"A whole multiple of interval_ms since the epoch, except the first bar, which starts with the period and may be shorter"},"to":{"type":"string","format":"date-time","description":"Start of the next bar; the last bar ends with the period and may be shorter, so scale it by its width"},"requests":{"type":"integer"},"bytes":{"type":"integer","description":"Response bytes, for the bandwidth metric only","nullable":true}}}},"split_by":{"type":"string","description":"The split field, null without one","nullable":true},"series":{"type":"array","description":"One per value, bar by bar: the known values of the field first, then up to 50 others, then null; each count equals the list filtered on that value over that bar. Empty without a split","items":{"type":"object","required":["value","requests","bytes","total_requests","total_bytes"],"properties":{"value":{"description":"Value id, raw value, or null for no value","anyOf":[{"type":"string"},{"type":"integer"},{"type":"object","nullable":true,"enum":[null]}]},"requests":{"type":"array","items":{"type":"integer"}},"bytes":{"type":"array","items":{"type":"integer"},"nullable":true},"total_requests":{"type":"integer"},"total_bytes":{"type":"integer","nullable":true}}}},"other":{"type":"object","description":"Requests no series covers, bar by bar (a status outside 100-599); null without a split","required":["requests","bytes"],"properties":{"requests":{"type":"array","items":{"type":"integer"}},"bytes":{"type":"array","items":{"type":"integer"},"nullable":true}},"nullable":true}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/response-times":{"post":{"summary":"Response time percentiles per bar of the view, and over the whole period","tags":["Traffic explorer"],"description":"Read only. Takes the body of the request search. p50, p75 and p95 in HDR at 2 significant digits, over the requests that carry a measured time; every bar of the period is returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["interval_ms","period","total","buckets"],"properties":{"interval_ms":{"type":"integer","description":"Width of a bar; the first and last ones are cut by the period and may be shorter"},"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"description":"The period drawn: the requested one, or the whole retention for a Request ID search"},"total":{"type":"object","description":"Over the whole period, for the header","required":["requests","p50","p75","p95"],"properties":{"requests":{"type":"integer","description":"Exact number of requests of the view"},"p50":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true},"p75":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true},"p95":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true}}},"buckets":{"type":"array","description":"Every bar from the period start; percentiles in HDR at 2 significant digits, over measured times","items":{"type":"object","required":["from","to","requests","p50","p75","p95"],"properties":{"from":{"type":"string","format":"date-time","description":"A whole multiple of interval_ms since the epoch, except the first bar, which starts with the period and may be shorter"},"to":{"type":"string","format":"date-time","description":"Start of the next bar; the last bar ends with the period and may be shorter, so scale it by its width"},"requests":{"type":"integer"},"p50":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true},"p75":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true},"p95":{"type":"number","description":"Milliseconds; null without any measured time","nullable":true}}}}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/groups/{fieldId}":{"post":{"summary":"The first 50 values of a field in the view, with requests, mean bytes, server errors and p95","tags":["Traffic explorer"],"description":"Read only. Takes the body of the request search. IP address cannot be grouped by; URL and referrer only over 6 hours at most: beyond, 400 period_too_long gives the limit in details.max_period_ms. A Request ID search, which reads the whole retention for a request or two, has no such limit. Each count equals the list filtered on that value. Platform loop-back hops are never counted.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["period"],"additionalProperties":false,"properties":{"period":{"type":"object","required":["from","to"],"additionalProperties":false,"description":"Inside the retention served by the fields route; a request_id search covers the whole retention instead","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"filters":{"type":"array","maxItems":30,"description":"AND-ed; the values of one filter are OR-ed","items":{"type":"object","required":["field","operator","values"],"additionalProperties":false,"properties":{"field":{"type":"string","description":"A filterable field id of the catalog"},"operator":{"type":"string","enum":["include","exclude","gte","lte"],"description":"Among the operators the fields route lists for the field: gte and lte bound a measure"},"values":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Value ids or raw values; null matches a request that carries no value. One flag per value for fstrz_flags, one number for gte and lte","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","nullable":true,"enum":[null]}]}}}}},"search":{"type":"object","required":["scope","text"],"additionalProperties":false,"properties":{"scope":{"type":"string","enum":["url","user_agent","referrer","ip_address","request_id"]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":"url, user_agent, referrer: contains the words; ip_address, request_id: exact value"}}}}}}}},"parameters":[{"schema":{"type":"string","enum":["requests","ratio","errors","p95","avg_bytes"],"default":"requests"},"in":"query","name":"sort","required":false,"description":"Column the values are ranked on, among the 1000 most requested values; errors is the share of server errors, ratio ranks as requests do. p95 is refused for a derived field (400 sort_not_available)"},{"schema":{"type":"string","enum":["desc","asc"],"default":"desc"},"in":"query","name":"order","required":false},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"},{"schema":{"type":"string","maxLength":64},"in":"path","name":"fieldId","required":true,"description":"A groupable field id of the catalog"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["rows","total","other_count","ranked_values","period"],"properties":{"rows":{"type":"array","description":"Up to 50 values, sorted on the requested column, values without a p95 last. Each count equals the list filtered on that value. Ratio is requests / total and Errors server_errors / requests; a list field such as block_reason counts a request under each of its values, so its ratios can add up past 1","items":{"type":"object","required":["value","requests","avg_bytes","server_errors","p95"],"properties":{"value":{"description":"Value id, raw value, or null for no value","anyOf":[{"type":"string"},{"type":"integer"},{"type":"object","nullable":true,"enum":[null]}]},"requests":{"type":"integer"},"avg_bytes":{"type":"integer","description":"Mean response bytes per request of the value, rounded to the byte"},"server_errors":{"type":"integer","description":"Requests answered with a 5xx"},"p95":{"type":"number","description":"Milliseconds; null without any measured time, and always null for a derived field such as status_group, whose p95 cannot be taken from its raw values","nullable":true}}}},"total":{"type":"integer","description":"Exact number of requests of the view"},"other_count":{"type":"integer","description":"Requests no ranked value stands for: past the 1000 most requested values, which every sort ranks, longer than the 256 characters the logs store can rank (a URL or a referrer), or matching no value of a derived field. The ranked values left out past the first 50 rows are not counted here; 0 means the sort ranked every value exactly"},"ranked_values":{"type":"integer","description":"1000 when the view holds more rankable values than that: the sort then ranks only the 1000 most requested, and a value requested less often is never a row, however slow or heavy. null when the cap left no rankable value out, and for a derived field; a value longer than the 256 characters the logs store can rank is never rankable, and is counted in other_count","nullable":true},"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"description":"The period counted: the requested one, or the whole retention for a Request ID search"}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}},"409":{"description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","content":{"application/json":{"schema":{"type":"object","description":"The traffic of this website cannot be explored (reason: cdn_not_supported, wildcard_domain_not_supported).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}},"503":{"description":"The logs store did not answer in time or answered partially, retry later.","content":{"application/json":{"schema":{"type":"object","description":"The logs store did not answer in time or answered partially, retry later.","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["statusCode","error","reason","message"]}}}}}}},"/v2/websites/{websiteId}/traffic/changes":{"get":{"summary":"Configuration changes of a website over a period, to mark on the traffic timeline","tags":["Traffic explorer"],"description":"Read only. The operations that change what the website serves, created from `from` included to `to` excluded, 6 days at most (400 period_too_long otherwise), oldest first and without paging: past 1000, only the most recent and is_complete false. Failed operations and partial cache purges are left out. A member of the Fasterize team is never named, whoever reads.","parameters":[{"schema":{"type":"string","format":"date-time"},"in":"query","name":"from","required":true,"description":"Start of the period, included"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"to","required":true,"description":"End of the period, excluded; at most 6 days after from"},{"schema":{"type":"string","pattern":"^[0-9]+$"},"in":"path","name":"websiteId","required":true,"description":"Website ID (numeric)"}],"security":[{"Secret API key":[],"JWT":["website:read"]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["period","changes","is_complete"],"properties":{"period":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"changes":{"type":"array","description":"Oldest first, created from the start of the period included to its end excluded","items":{"type":"object","required":["id","at","kind","application_id","author"],"properties":{"id":{"type":"integer","description":"Operation id"},"at":{"type":"string","format":"date-time","description":"When the operation was created"},"kind":{"type":"string","enum":["config_update","cache_flush","plug","unplug","optimization_applied","optimization_removed","application_install","application_uninstall","application_update","rule_change","cdn_change"]},"application_id":{"type":"string","description":"The application changed, for the application_* kinds; null otherwise","nullable":true},"author":{"oneOf":[{"type":"object","required":["kind","name"],"additionalProperties":false,"properties":{"kind":{"type":"string","enum":["customer"]},"name":{"type":"string"}}},{"type":"object","required":["kind"],"additionalProperties":false,"properties":{"kind":{"type":"string","enum":["fasterize"]}}},{"type":"object","required":["kind"],"additionalProperties":false,"properties":{"kind":{"type":"string","enum":["none"]}}}],"description":"customer: a user of the customer or of its partner, by name. fasterize: a member of the Fasterize team, never named. none: no named user, such as an automated operation, a deleted account or an account without a name"}}}},"is_complete":{"type":"boolean","description":"False past 1000 changes in the period: only the most recent are listed"}}}}}},"400":{"description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","content":{"application/json":{"schema":{"type":"object","description":"The view cannot be searched (reason: invalid_period, invalid_filter, field_unknown, field_not_filterable, operator_not_allowed, field_unavailable, field_not_facetable, field_not_splittable, field_not_groupable, sort_not_available, invalid_search, invalid_range, period_too_long, invalid_time_zone).","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"details":{"type":"object","properties":{"field":{"type":"string","description":"The field at fault, when one is"},"max_period_ms":{"type":"integer","description":"For period_too_long: the longest period, in milliseconds, the request may cover"}}}},"required":["statusCode","error","message"]}}}}}}},"/mcp":{"post":{"summary":"Fasterize MCP entry point (Streamable HTTP)","tags":["MCP"],"description":"Exposes the Fasterize MCP tools (list_sites, get_site_config, get_site_status, list_recent_operations, purge_cache, diagnose_url, get_url_cache_status, list_installed_applications, get_application_config, get_certificates, get_operation_status, get_inlinks_summary, get_seo_metadata_assessment, get_search_console_metrics, get_webperf_ranking, get_traffic_metrics, toggle_optimization, get_shield_config) behind Auth0 auth. Each tool re-checks the user's actual RBAC. The mutative tools purge_cache (cache:write) and toggle_optimization (optimization:write) are confirmed on the agent side (HITL). A client whose session is about a single site SHOULD send the X-Fasterize-Config-Scope header: every tool call for another configId is then refused, regardless of RBAC (see mcp/scope.ts), and list_sites and get_shield_config are not exposed. A direct client (no scope) starts with list_sites to resolve a domain into a configId.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{}}},"/v2/status":{"get":{"responses":{"200":{"description":"Health Check Succeeded","content":{"application/json":{"schema":{"type":"object","description":"Health Check Succeeded","example":{"status":"ok"},"properties":{"status":{"type":"string"}}}}}},"500":{"description":"Error Performing Health Check","content":{"application/json":{"schema":{"type":"object","description":"Error Performing Health Check","properties":{"message":{"type":"string","description":"Error message for failure during health check","example":"Internal Server Error"},"statusCode":{"type":"number","description":"Code representing the error. Always matches the HTTP response code.","example":500}}}}}},"503":{"description":"Health Check Failed","content":{"application/json":{"schema":{"type":"object","description":"Health Check Failed","properties":{"code":{"type":"string","description":"Error code associated with the failing check","example":"FST_UNDER_PRESSURE"},"error":{"type":"string","description":"Error thrown during health check","example":"Service Unavailable"},"message":{"type":"string","description":"Error message to explain health check failure","example":"Service Unavailable"},"statusCode":{"type":"number","description":"Code representing the error. Always matches the HTTP response code.","example":503}}}}}}}}}},"servers":[{"url":"https://api.fasterize.com"}],"tags":[],"externalDocs":{"url":"https://support.fasterize.com/fr/support/solutions/43000358006","description":"Section API of the documentation website"},"x-tagGroups":[{"name":"Organizations","tags":["Organizations","Organization Members","Profile"]},{"name":"Website Management","tags":["Websites","Website Status","Cache Purge","Access logs","Activity Events"]},{"name":"Global Settings","tags":["Domain","Geo IP","HTTP Header","Network"]},{"name":"EdgeSpeed","tags":["Target","Css","Edge Rewriter","Font","HTML","Image","Js","Full Page Caching","Preload","Static Cache","Self-Hosting"]},{"name":"EdgeSeo","tags":["Bulk Redirection","Bulk Seo","Bulk Url Rewriting","Data Storage","Robotstxt","Llmstxt","Seo Recommendation","Sitemap","Sitemap Cleaner","Url Rewriting"]},{"name":"EdgeGuard","tags":["Datadome","Firewall","Traffic Limiter"]},{"name":"Monitoring","tags":["Webperf Data Monitoring"]}],"nextToButton":true}