/actions
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxActionGroupResource": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get every actions
/applications
GET
[
{
"name": "type",
"in": "query",
"required": false,
"type": "string",
"enum": [
"SITE",
"BACKEND",
"MICRO_APPLICATION"
]
},
{
"name": "environment",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "expand",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"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 all applications
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"
]
}
}
},
{
"name": "activate",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"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"
]
}
}
}
]
Register a new application
/applications/{appId}
GET
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "expand",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"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 application by it’s ID
PUT
[
{
"name": "appId",
"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"
]
}
}
},
{
"name": "activate",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"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": "appId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete an application
PATCH
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/JsonPatchOperation"
}
}
},
{
"name": "activate",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"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 an application (atomic updates)
/applications/{appId}/components
POST
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FRAGMENT",
"APPLICATION_CONTEXT"
]
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ComponentResource": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FRAGMENT",
"APPLICATION_CONTEXT"
]
}
}
}
]
Update an application
/applications/{appId}/components/{compId}
PUT
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "compId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FRAGMENT",
"APPLICATION_CONTEXT"
]
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ComponentResource": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FRAGMENT",
"APPLICATION_CONTEXT"
]
}
}
}
]
Update an application
DELETE
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "compId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoRemovedElement": ""
}
]
Update an application
/applications/{appId}/enable
GET
[
{
"name": "appId",
"in": "path",
"required": true,
"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"
]
}
}
}
]
Activate an application (set it LIVE)
/applications/{appId}/using
GET
[
{
"name": "appId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoRegistrySearchResponse": ""
}
]
Get Sites and Experiences using an application
/config/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 Site configurations
/config/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 by its ID and version (default LIVE)
/config/sites/{siteId}/experiences
GET
[
{
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 Experienced configurations for a Site
/config/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#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 an Experienced configurations for a Site
/events
GET
[
{
"name": "name",
"in": "query",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxRegistrationEvent": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Subscribe to events flux
/events/listeners
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#FluxString": {
"prefetch": {
"type": "integer",
"format": "int32"
}
}
}
]
Get subscribers to events flux
/roles
GET
[
{
"name": "withCount",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 Sites
POST
[
{
"name": "siteAdmin",
"in": "query",
"required": false,
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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
/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 by it’s ID and version (default LIVE)
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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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
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
PATCH
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/JsonPatchOperation"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#SiteConfigResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 (atomic updates)
/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 Experience for a Site
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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 for a Site
/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 by it’s ID
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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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": "array",
"items": {
"$ref": "#/definitions/JsonPatchOperation"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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}/experiences/{experienceId}/application/{version}
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "mount",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "timeout",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ExperienceResource": {
"contact": {
"type": "string"
},
"version": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainConfigResource"
}
},
"devices": {
"$ref": "#/definitions/NamedPatternConfigResource"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 application version
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "experienceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
}
}
}
}
]
Delete an Experience application version
/sites/{siteId}/preview-devices
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#PreviewDevicesResource": {
"siteId": {
"type": "string"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
}
}
}
]
Get the site preview devices
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#PreviewDevicesResource": {
"siteId": {
"type": "string"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
}
}
}
]
Save the site preview devices
/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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 (set it LIVE)
/sites/{siteId}/resource-types
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypesResource": {
"siteId": {
"type": "string"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
}
}
}
]
Get the site resource types
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#ResourceTypesResource": {
"siteId": {
"type": "string"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
}
}
}
]
Save the site resource types
/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"
},
"previewDevices": {
"type": "array",
"items": {
"$ref": "#/definitions/PreviewDeviceResource"
}
},
"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"
},
"resourceTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceTypeResource"
}
},
"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"
}
}
}
]
Restore a Site version (save the current LIVE as Vx and set the version as LIVE
/sites/{siteId}/roles
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "withCount",
"in": "query",
"required": false,
"type": "boolean",
"default": false
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#RoleResource": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"siteId": {
"type": "string"
},
"nbUsers": {
"type": "integer",
"format": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"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": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"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": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Create a new role
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a 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": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"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": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"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}/roles/{roleId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "roleId",
"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": "int64"
},
"actions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"isLocked": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isSuperAdmin": {
"type": "boolean"
}
}
}
]
Get every roles
/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#MonoPageableResourceUserResource": ""
}
]
Get every users
POST
[
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
Create a new User
/users/me
GET
[]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
Get current User
/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#MonoPageableResourceUserResource": ""
}
]
Search a User
/users/user-id/{externalId}
GET
[
{
"name": "externalId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
Get a User by external ID
/users/{id}
GET
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
Get a User
PUT
[
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#UserResource": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/RoleResource"
}
},
"globalActions": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"siteActions": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"favoriteSite": {
"$ref": "#/definitions/SiteConfigResource"
},
"favoriteLocale": {
"type": "string"
},
"isBatch": {
"type": "boolean"
},
"lastLogin": {
"type": "string",
"format": "date"
},
"userId": {
"type": "string"
}
}
}
]
Update a User
/users/{userId}
DELETE
[
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete a User