/sites/{siteId}/aliases/{aliasName}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "aliasName",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#AliasDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"alias": {
"type": "string"
}
}
}
]
Get an alias by name
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "aliasName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "overwrite",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "removeOthers",
"in": "query",
"required": false,
"type": "boolean"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"alias": {
"type": "string"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#AliasDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"alias": {
"type": "string"
}
}
}
]
Create or update an alias
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "aliasName",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete an alias
/sites/{siteId}/locales/{locale}/aliases/{alias}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "alias",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoResolvedResource": ""
}
]
Resolve an alias (calculate its URL)
/sites/{siteId}/locales/{locale}/resources
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"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": "aggregations",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Search a 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,
"type": "ref"
},
{
"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": "aggregations",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "expands",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Search a resource by its type
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"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 form a type and a locale
/sites/{siteId}/locales/{locale}/resources/{resourceType}/resolve
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceScope",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "mode",
"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"
}
}
}
]
Bulk resolve a resource (calculate a list of URL)
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "mode",
"in": "query",
"required": false,
"type": "string",
"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 (calculate its URL)
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "resourceType",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resourceId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "ttl",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "mode",
"in": "query",
"required": false,
"type": "string",
"enum": [
"OVERWRITE",
"FORCE",
"USE_CACHE",
"FORCE_DRY",
"USE_CACHE_OR_DRY",
"USE_CACHE_OR_DRY_ON_4XX"
]
},
{
"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"
}
}
}
]
[
{
"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,
"type": "ref"
},
{
"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 by locale
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}/info
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"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": ""
}
]
Search a resource by its type and ID
/sites/{siteId}/locales/{locale}/resources/{resourceType}/{resourceId}/redirection
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"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"
},
"passthrough": {
"type": "boolean"
},
"passthroughUntil": {
"type": "string",
"format": "date-time"
},
"migrationPlan": {
"type": "array",
"items": {
"$ref": "#/definitions/HttpStatusOnDate"
}
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Redirect a resource to another
/sites/{siteId}/locales/{locale}/tenants/{tenantId}/paths/{path}
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "tenantId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoResolvedPath": ""
}
]
Resolve a resource by path
PUT
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "tenantId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"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"
},
"passthrough": {
"type": "boolean"
},
"passthroughUntil": {
"type": "string",
"format": "date-time"
},
"migrationPlan": {
"type": "array",
"items": {
"$ref": "#/definitions/HttpStatusOnDate"
}
}
}
},
{
"name": "overwriteExistingOk",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "overwriteExisting",
"in": "query",
"required": false,
"type": "boolean"
}
]
[
{
"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"
}
}
}
}
]
Create or update an URL
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"name": "tenantId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"in": "path",
"required": true,
"type": "string"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoVoid": ""
}
]
Delete an URL
/sites/{siteId}/locales/{locale}/urls
GET
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale",
"in": "path",
"required": true,
"type": "ref"
},
{
"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": "aggregations",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoPageResolverDocumentWrapper": ""
}
]
Search URLs by HTTP status
/sites/{siteId}/resources
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/ResolutionItem"
}
}
}
},
{
"name": "mode",
"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#MonoBulkResolveResponse": ""
}
]
Bulk resolve every resources (calculate a list of URL)
/sites/{siteId}/resources/{resourceType}/{resourceId}
DELETE
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"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 for every locales
/sites/{siteId}/resources/{resourceType}/{resourceId}/aliases
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"
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#AliasDto": {
"siteId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"URL",
"RESOURCE",
"ALIAS"
]
},
"alias": {
"type": "string"
}
}
}
]
Get every aliases for a resource
/sites/{siteId}/urls
POST
[
{
"name": "siteId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"siteId": {
"type": "string"
},
"redirectionType": {
"type": "string",
"enum": [
"CONTINUE",
"SWITCHING_PROTOCOLS",
"PROCESSING",
"CHECKPOINT",
"OK",
"CREATED",
"ACCEPTED",
"NON_AUTHORITATIVE_INFORMATION",
"NO_CONTENT",
"RESET_CONTENT",
"PARTIAL_CONTENT",
"MULTI_STATUS",
"ALREADY_REPORTED",
"IM_USED",
"MULTIPLE_CHOICES",
"MOVED_PERMANENTLY",
"FOUND",
"MOVED_TEMPORARILY",
"SEE_OTHER",
"NOT_MODIFIED",
"USE_PROXY",
"TEMPORARY_REDIRECT",
"PERMANENT_REDIRECT",
"BAD_REQUEST",
"UNAUTHORIZED",
"PAYMENT_REQUIRED",
"FORBIDDEN",
"NOT_FOUND",
"METHOD_NOT_ALLOWED",
"NOT_ACCEPTABLE",
"PROXY_AUTHENTICATION_REQUIRED",
"REQUEST_TIMEOUT",
"CONFLICT",
"GONE",
"LENGTH_REQUIRED",
"PRECONDITION_FAILED",
"PAYLOAD_TOO_LARGE",
"REQUEST_ENTITY_TOO_LARGE",
"URI_TOO_LONG",
"REQUEST_URI_TOO_LONG",
"UNSUPPORTED_MEDIA_TYPE",
"REQUESTED_RANGE_NOT_SATISFIABLE",
"EXPECTATION_FAILED",
"I_AM_A_TEAPOT",
"INSUFFICIENT_SPACE_ON_RESOURCE",
"METHOD_FAILURE",
"DESTINATION_LOCKED",
"UNPROCESSABLE_ENTITY",
"LOCKED",
"FAILED_DEPENDENCY",
"UPGRADE_REQUIRED",
"PRECONDITION_REQUIRED",
"TOO_MANY_REQUESTS",
"REQUEST_HEADER_FIELDS_TOO_LARGE",
"UNAVAILABLE_FOR_LEGAL_REASONS",
"INTERNAL_SERVER_ERROR",
"NOT_IMPLEMENTED",
"BAD_GATEWAY",
"SERVICE_UNAVAILABLE",
"GATEWAY_TIMEOUT",
"HTTP_VERSION_NOT_SUPPORTED",
"VARIANT_ALSO_NEGOTIATES",
"INSUFFICIENT_STORAGE",
"LOOP_DETECTED",
"BANDWIDTH_LIMIT_EXCEEDED",
"NOT_EXTENDED",
"NETWORK_AUTHENTICATION_REQUIRED"
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/UrlRedirectionItem"
}
},
"overwriteExistingOk": {
"type": "boolean"
},
"overwriteExisting": {
"type": "boolean"
}
}
}
]
[
{
"status": "200",
"description": "successful operation",
"schema#MonoBulkRedirectResponse": ""
}
]
Bulk resolve redirections
/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",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"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": ""
}
]
Search a resource by its URL