API routes (Click a route to expand it, click here to expand/collapse all)
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
POST/mgmt/plugin/clear/translations ⎘Authentication required
Clears the Translations-plugin cache. Should only be invoked against services that utilize this plugin.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag POST-body string
format: [A-Za-z0-9-]+
 Yes null Language to clear the translations for, for example "en", "en-US" or "en-US-x-cw". If not provided, clears the translations for all languages
rootNamespace POST-body string
enum: [ "ui", "mail", "err", "red", "wf", "mgmt" ]
 Yes null Root Namespace to clear specific cached translations, for example "ui" "red". If not provided, clears the root namespace for all translations.
Response HTTP Type Description
Success 200 bool Returns true.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
POST/send ⎘Authentication required
Send a mapped payload to Unite
Parameter Location Type Requirements Optional Default value Description
payload POST-body string
format: json
maxLength: 4194304
 No The payload that will be mapped and send to Unite
mappingKey POST-body string
pattern: ^[a-zA-Z0-9]{3,}$
maxLength: 64
 Yes "default" The name of the mapping.
Response HTTP Type Description
Success 200 string Success result of sending data to Unite
InvalidJSONException 500 JSON-string could not be parsed into valid JSON.
ExternalServiceBadRequestException 502 The queue, environment or app is not allowed.
ExternalServiceNotFoundException 502 The URI or method is incorrect
ExternalServiceUnauthorizedException 401 The x-functions-key is not allowed
ExternalServiceUnexpectedErrorException 502 An unexpected error occurred while processing the request.
MappingNotFoundException 404 Unable to locate mapping definition. See error details for mapping key.
OriginDomainNotAllowedException 403 The origin domain is not allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
unite-nl:* ⎘
POST/validateMapping ⎘
Validate mapping
Parameter Location Type Requirements Optional Default value Description
mappingKey POST-body string
pattern: ^[a-zA-Z0-9]{3,}$
maxLength: 64
 Yes "default" The name of the mapping.
Response HTTP Type Description
Success 200 boolean Validate result of mapping
MappingNotFoundException 404 Unable to locate mapping definition. See error details for mapping key.
ValidateMappingException 400 Mapping validation failed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error