/actions
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxActionGroupResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every actions
/applications
GET
[
{
"name": "environment",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationResource": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
Get every application filtered by environment, name or version
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationResource": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
Create a new application
/applications/images
POST
[
{
"name": "image",
"in": "formData",
"required": true,
"type": "ref"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxString": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Convert an image to base64 string
/applications/{id}
GET
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationResource": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
Get an application by it’s ID
PUT
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationResource": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
Update an application
DELETE
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete an application by it’s ID
PATCH
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "string"
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationResource": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"environment": {
"type": "string"
},
"name": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"label": {
"type": "string"
},
"starterVersion": {
"type": "string"
},
"rewriteContentTypePattern": {
"$ref": "#/definitions/Pattern"
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"applicationType": {
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
}
}
}
]
Patch anapplication (atomic updates)
/applications/{id}/sites
GET
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxSiteIdentifierResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every Site using this application
/applications/{id}/using
GET
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxSiteIdentifierResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every Site and Experience using this application
/csrf
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoString": ""
}
]
/fragment-definitions/{fragId}/renderables
GET
[
{
"name": "fragId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "siteId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxWebPageResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every renderable elements for a given fragment
/pages/{siteId}/type/{type}/id/{id}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"resourceScope": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Migrate the resource and model for a page
/pages/{siteId}/type/{type}/id/{id}/migrate-tenant
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"tenantId": {
"type": "string"
},
"path": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Migrate a page to another tenant with a new path
/roles
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Get every roles
/sites
GET
[
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Get every configured Site
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
},
{
"name": "adminUserId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Create a new Site configuration
/sites/labels
GET
[
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxSiteIdentifierResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every configured Site
/sites/{siteId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Get a Site configuration
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Update a Site configuration
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxRemovedElement": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Delete a Site configuration
PATCH
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "string"
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Patch a Site configuration (atomic updates)
/sites/{siteId}/aliases
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "query",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#AliasResource": {
"siteId": {
"type": "string"
},
"alias": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
}
}
}
]
Get every aliases for a Site
/sites/{siteId}/aliases/{alias}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "alias",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#AliasResource": {
"siteId": {
"type": "string"
},
"alias": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
}
}
}
]
Get an alias by it’s name
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "alias",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"alias": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoString": ""
}
]
Create or update an alias for a resource type and ID, delete the old aliases
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "alias",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete an alias
/sites/{siteId}/application-context-definitions
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxApplicationContextResourceWithModel": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every application context definitions for a Site
/sites/{siteId}/application-contexts
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationContextResource": ""
}
]
Add an application context in a Page Model
/sites/{siteId}/application-contexts/{id}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationContextResource": ""
}
]
Update an application context
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageModelId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationContextResource": ""
}
]
Delete an application context
/sites/{siteId}/application-contexts/{id}/move
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ApplicationContextResource": ""
}
]
Move an application context
/sites/{siteId}/containers/
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageVariationId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"restrictions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoContainerResource": ""
}
]
Add a container in a Page variation or Page Model
/sites/{siteId}/containers/{id}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageVariationId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"restrictions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoContainerResource": ""
}
]
Update a container
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageVariationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pageModelId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "force",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoContainerResource": ""
}
]
Delete a container
/sites/{siteId}/containers/{id}/move
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageVariationId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
},
"restrictions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoContainerResource": ""
}
]
Move a container in a Page variation or Page Model
/sites/{siteId}/devices
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxDeviceResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
/sites/{siteId}/devices/{deviceId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoDeviceResource": ""
}
]
Get a device
/sites/{siteId}/experiences
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Get every Site’s Experiences
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Create a new Experience
/sites/{siteId}/experiences/{experienceId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Get an Experience
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Update an Experience
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoRemovedElement": ""
}
]
Delete an Experience
PATCH
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "string"
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"siteId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Patch an Experience (atomic updates)
/sites/{siteId}/fragment-definitions
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxFragmentResourceWithDate": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every fragment definitions
/sites/{siteId}/fragment-definitions/{id}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoFragmentResourceWithDate": ""
}
]
Get a fragment definition by ID
/sites/{siteId}/fragment-definitions/{id}/thumbnail
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoResponseEntityResource": ""
}
]
Get a fragment definition thumbnail
/sites/{siteId}/fragments/{id}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoFragmentConfigResource": ""
}
]
Get a fragment by ID
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageVariationId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"fragmentDefinitionId": {
"type": "string"
},
"configuration": {
"$ref": "#/definitions/JsonNode"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoFragmentConfigResource": ""
}
]
Update a fragment
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageVariationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pageModelId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxFragmentConfigResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Delete a fragment
/sites/{siteId}/fragments/{id}/move
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"pageVariationId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"id": {
"type": "string"
},
"fragmentDefinitionId": {
"type": "string"
},
"configuration": {
"$ref": "#/definitions/JsonNode"
},
"anchor": {
"type": "string"
},
"parent": {
"$ref": "#/definitions/ParentResource"
},
"afterComponentId": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoFragmentConfigResource": ""
}
]
Move a fragment (container or afterComponentId)
/sites/{siteId}/locales/{locale}/resources
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "statuses",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"collectionFormat": "multi"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "countOnly",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Get resource by HTTP status
/sites/{siteId}/locales/{locale}/resources/{resourceType}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "statuses",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"collectionFormat": "multi"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "countOnly",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "expands",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Get resources by resource type
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete every resources of a type
/sites/{siteId}/locales/{locale}/resources/{resourceType}/export
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxByte[]": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Exports resources matching type/scope to a csv file
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expands",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Get resource by type and ID
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"status": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string"
},
"resourceScope": {
"type": "string"
},
"expire": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
}
}
},
{
"name": "ttl",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "resolutionMode",
"in": "query",
"required": false,
"type": "string",
"enum": [
"OVERWRITE",
"FORCE",
"USE_CACHE",
"FORCE_DRY",
"USE_CACHE_OR_DRY",
"USE_CACHE_OR_DRY_ON_4XX"
]
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResolvedResourceDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"status": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string"
},
"resourceScope": {
"type": "string"
},
"expire": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
}
}
}
]
Create or update a resource
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a resource
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}/resolution
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "mode",
"in": "query",
"required": false,
"type": "string",
"default": "USE_CACHE",
"enum": [
"OVERWRITE",
"FORCE",
"USE_CACHE",
"FORCE_DRY",
"USE_CACHE_OR_DRY",
"USE_CACHE_OR_DRY_ON_4XX"
]
},
{
"name": "preview",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResolvedResourceDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"status": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string"
},
"resourceScope": {
"type": "string"
},
"expire": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
}
}
}
]
Resolve a resource with specified ResolutionMode
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}/unpublication
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoUnpublicationChecklist": ""
}
]
Checklist for resource unpublication
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"action": {
"type": "string",
"enum": [
"DELETE",
"REDIRECT",
"DEREFERENCE"
]
},
"redirect": {
"$ref": "#/definitions/PathResource"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Resource unpublication process
/sites/{siteId}/locales/{locale}/tenants/{tenantId}/paths/{path}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "tenantId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "overwriteExistingOk",
"in": "query",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "overwriteExisting",
"in": "query",
"required": false,
"type": "boolean",
"default": false
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"status": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string"
},
"resourceScope": {
"type": "string"
},
"expire": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"passthrough": {
"type": "boolean"
},
"passthroughUntil": {
"type": "string",
"format": "date-time"
},
"migrationPlan": {
"type": "array",
"items": {
"$ref": "#/definitions/HttpStatusOnDate"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UrlDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"status": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string"
},
"resourceScope": {
"type": "string"
},
"expire": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"passthrough": {
"type": "boolean"
},
"passthroughUntil": {
"type": "string",
"format": "date-time"
},
"migrationPlan": {
"type": "array",
"items": {
"$ref": "#/definitions/HttpStatusOnDate"
}
}
}
}
]
Update a URL
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "tenantId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a URL
/sites/{siteId}/locales/{locale}/urls
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "statuses",
"in": "query",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"collectionFormat": "multi"
},
{
"name": "canonical",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "countOnly",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Get URLs by HTTP status
/sites/{siteId}/page-models
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "liveOnly",
"in": "query",
"required": false,
"type": "boolean",
"default": true
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxPageModelResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every Page Models for a Site
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"parentId": {
"type": "string"
},
"templatePath": {
"type": "string"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/PageModelResourceTypeResource"
}
},
"errorTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageModelResource": ""
}
]
Create a new Page Model
/sites/{siteId}/page-models/roots
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxPageModelResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get the first Page Model (root) of a Site
/sites/{siteId}/page-models/{id}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageModelResource": ""
}
]
Get a Page Model
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"parentId": {
"type": "string"
},
"templatePath": {
"type": "string"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/PageModelResourceTypeResource"
}
},
"errorTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageModelResource": ""
}
]
Update a Page Model
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a Page Model
/sites/{siteId}/page-models/{id}/children
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxPageModelResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get children of a Page Model
/sites/{siteId}/page-models/{id}/draft
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete the DRAFT version of a Page Model
/sites/{siteId}/page-models/{pageModelId}/components
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageModelId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxAnchorableComponent": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every components of a Page Model
/sites/{siteId}/page-models/{pageModelId}/publish
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageModelId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Publish a Page Model
/sites/{siteId}/pages
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"parentId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"siteId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"isLeaf": {
"type": "boolean"
},
"alias": {
"type": "string"
},
"locks": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Create a new Page
/sites/{siteId}/pages/root
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "tenantId",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Get the first Page (root) of a Site
/sites/{siteId}/pages/{pageId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Get a Page
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"parentId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"siteId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"isLeaf": {
"type": "boolean"
},
"alias": {
"type": "string"
},
"locks": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResource": ""
}
]
Update a Page
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a Page
/sites/{siteId}/pages/{pageId}/children
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxPageResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get a Page’s children
/sites/{siteId}/pages/{pageId}/components
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxAnchorableComponent": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every components in a Page
/sites/{siteId}/pages/{pageId}/variations/{variationId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageVariationResource": ""
}
]
Get a variation of a Page
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"pageId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"name": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageVariationResource": ""
}
]
Duplicate a Page variation
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"pageId": {
"type": "string"
},
"pageModelId": {
"type": "string"
},
"name": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageVariationResource": ""
}
]
Update a Page variation
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a Page variation
/sites/{siteId}/pages/{pageId}/variations/{variationId}/draft
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete the DRAFT version of a published page variation
/sites/{siteId}/pages/{pageId}/variations/{variationId}/publish
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Publish a Page variation
/sites/{siteId}/publish
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Publish a Site configuration
/sites/{siteId}/redirect-errors-file
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/UrlRedirectionError"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Download redirect error report file
/sites/{siteId}/redirect-example-upload-file
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Get a redirect example file
/sites/{siteId}/resource-errors-file
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/ResolutionError"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Download resource error report file
/sites/{siteId}/resource-example-upload-file
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Get a resource example file
/sites/{siteId}/resource-types
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypeResource": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
Gets resource types
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypeResource": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
Create or update a resource type and associated scopes
PATCH
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypeResource": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
Patch resource type and associated scopes (atomic updates)
/sites/{siteId}/resource-types/usage
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxResourceTypeUsageResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Gets resource types with associated pages and page models
/sites/{siteId}/resource-types/{id}
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a resource type and associated scopes
/sites/{siteId}/resource-types/{resourceType}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypeResource": {
"id": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteId": {
"type": "string"
},
"isLocked": {
"type": "boolean"
}
}
}
]
Gets resource type by site identifier and resource type name
/sites/{siteId}/resources
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "dryRun",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoBulkResolveResponse": ""
}
]
Import resolution file
/sites/{siteId}/resources/export
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceDto"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Exports resources to a csv file
/sites/{siteId}/resources/{resourceType}/urls
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "locale",
"in": "query",
"required": false
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "force",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxUrlResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Resolve every resources of a type (calculate its URLs)
/sites/{siteId}/resources/{resourceType}/{resourceId}/urls
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "locale",
"in": "query",
"required": false
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "preview",
"in": "query",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "force",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxUrlResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Resolve a resource (calculate its URLs)
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"tenantId": {
"type": "string"
},
"locale": {
"$ref": "#/definitions/Locale"
},
"path": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoUrlResource": ""
}
]
Update a resource URL
/sites/{siteId}/resources/{resourceType}/{resourceId}/web-page
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "mode",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "date",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "preview",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "locale",
"in": "query",
"required": true
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoWebPageResource": ""
}
]
Get a web page informations from a Resource
/sites/{siteId}/resume
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
Copy a Site configuration version (V1, V2…) as DRAFT
/sites/{siteId}/roles
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Get every roles
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Create a new role
/sites/{siteId}/roles/{id}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int32"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Update a role
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a role
/sites/{siteId}/search/locales/{locale}/search/{input}
GET
[
{
"name": "input",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"default": 1,
"format": "int32"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"default": 10,
"format": "int32"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoDesignerSearchResponse": ""
}
]
Search a Page or Page Model by name
/sites/{siteId}/search/resources/{resourceType}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoDesignerSearchResponse": ""
}
]
Search a Page or Page Model by resource
/sites/{siteId}/search/urls/{url}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "url",
"in": "path",
"required": true,
"type": "string",
"format": "url"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoDesignerSearchResponse": ""
}
]
Search a Page or Page Model by URL
/sites/{siteId}/statuses/{statusCode}/redirects
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "statusCode",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "overwriteExistingOk",
"in": "query",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "overwriteExisting",
"in": "query",
"required": false,
"type": "boolean",
"default": false
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoBulkRedirectResponse": ""
}
]
Import redirect file
/sites/{siteId}/templates
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#TemplatePathResource": {
"path": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
Get every templates for a Site (Site application exposed templates resources)
/sites/{siteId}/urls/export
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/RedirectDto"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoByte[]": ""
}
]
Exports redirects to a csv file
/sites/{siteId}/urls/root
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "expId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tenantId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "locale",
"in": "query",
"required": false
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxUrlResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Resolve the root Page URL of a Site
/sites/{siteId}/urls/{url}/resources
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "url",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"default": 1,
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"default": 10,
"format": "int32"
},
{
"name": "expands",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Get resource by URL
/users
GET
[
{
"name": "siteId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"default": 1,
"format": "int32"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"default": 10,
"format": "int32"
},
{
"name": "sort",
"in": "query",
"required": false,
"type": "string",
"enum": [
"USERID_ASC",
"NICKNAME_ASC",
"LAST_LOGIN_ASC",
"USERID_DESC",
"NICKNAME_DESC",
"LAST_LOGIN_DESC"
]
},
{
"name": "withRoles",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoSortedPageableUserResourceUserPageSort": ""
}
]
Get every users
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
},
{
"name": "email",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Create a new User
/users/authenticate
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"code": {
"type": "string"
},
"host": {
"type": "string"
},
"redirectUri": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoMapStringString": ""
}
]
/users/current
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Get current User
/users/current/favoriteLocale
PUT
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "string"
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Update current User favorite locale
/users/current/favoriteSite
PUT
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"browsers": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"bots": {
"$ref": "#/definitions/SinglePatternConfigResource"
},
"security": {
"$ref": "#/definitions/SecurityConfigResource"
},
"backendRoutes": {
"type": "array",
"items": {
"$ref": "#/definitions/BackendRoutingConfigResource"
}
},
"applicationRules": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationRuleResource"
}
},
"cookies": {
"type": "array",
"items": {
"$ref": "#/definitions/CookieConfigResource"
}
},
"headers": {
"type": "array",
"items": {
"$ref": "#/definitions/HeaderConfigResource"
}
},
"developer": {
"$ref": "#/definitions/DeveloperConfigResource"
},
"errorPage": {
"$ref": "#/definitions/ErrorPageConfigResource"
},
"staticResource": {
"$ref": "#/definitions/StaticResourceConfigResource"
},
"update": {
"$ref": "#/definitions/EventLogResource"
},
"publication": {
"$ref": "#/definitions/EventLogResource"
},
"id": {
"type": "string"
},
"expId": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"cdn": {
"type": "array",
"items": {
"type": "string"
}
},
"locales": {
"type": "array",
"items": {
"$ref": "#/definitions/Locale"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantConfigResource"
}
},
"resolver": {
"$ref": "#/definitions/ResolverConfigResource"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Update current User favorite Site
/users/current/nickname
PUT
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "string"
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Update current User nickname
/users/current/roles/request
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"roleIds": {
"type": "array",
"items": {
"type": "string"
}
},
"comment": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoBoolean": ""
}
]
Request access
/users/logout
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoRevokeTokenResource": ""
}
]
/users/search/{searchText}
GET
[
{
"name": "searchText",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "siteId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"default": 1,
"format": "int32"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"default": 10,
"format": "int32"
},
{
"name": "sort",
"in": "query",
"required": false,
"type": "string",
"enum": [
"USERID_ASC",
"NICKNAME_ASC",
"LAST_LOGIN_ASC",
"USERID_DESC",
"NICKNAME_DESC",
"LAST_LOGIN_DESC"
]
},
{
"name": "withRoles",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoSortedPageableUserResourceUserPageSort": ""
}
]
Search a User
/users/{id}
GET
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Get a User
PUT
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Update a User
/users/{id}/roles
PUT
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"USERS_CREATE",
"USERS_UPDATE",
"USERS_DELETE",
"ROLES_CREATE",
"ROLES_UPDATE",
"ROLES_DELETE",
"MODELS_CREATE",
"MODELS_UPDATE",
"MODELS_DELETE",
"MODELS_PUBLISH",
"MODELS_RESTRICT",
"MODELS_SEO",
"PAGES_CREATE",
"PAGES_UPDATE",
"PAGES_DELETE",
"PAGES_PUBLISH",
"PAGES_VARIATIONS_CREATE",
"PAGES_VARIATIONS_UPDATE",
"PAGES_SEO",
"RESOURCES_CREATE",
"RESOURCES_UPDATE",
"RESOURCES_DELETE",
"ALIASES_CREATE",
"ALIASES_UPDATE",
"ALIASES_DELETE",
"URLS_CREATE",
"URLS_UPDATE",
"URLS_DELETE",
"SITES_CREATE",
"SITES_UPDATE",
"SITES_DELETE",
"APPLICATIONS_CREATE",
"APPLICATIONS_UPDATE",
"APPLICATIONS_DELETE",
"EXPERIENCES_CREATE",
"EXPERIENCES_UPDATE",
"EXPERIENCES_DELETE"
]
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string"
}
}
}
]
Update current User roles
/users/{userId}
DELETE
[
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a User
/viewer/sites/{siteId}/page-models/{pageModelId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageModelId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoViewerResponseResource": ""
}
]
Get a Page model path (for preview)
/viewer/sites/{siteId}/pages/{pageId}/variations/{variationId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoViewerResponseResource": ""
}
]
Get a Page variation path (for preview)
/viewer/sites/{siteId}/resources/{resourceType}/{resourceId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variationId",
"in": "query",
"required": false,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoViewerResponseResource": ""
}
]
Get a Resource path (for preview)