API routes (Click a route to expand it, click here to expand/collapse all)
Default APIs
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
    REDHistory API
    GET/history/{idREDSet}/{REDPath} ⎘Authentication required
    Show history of a given REDPath on a REDSet.
    Parameter Location Type Requirements Optional Default value Description
    idREDSet URI-Path string
    pattern: ^[a-z0-9]{24}$
    		 No The id of the REDSet you want to replay.
    idGroups URI-Query int[] No ID's of the groups for the REDDefinition.
    historyType URI-Query string
    enum: [ "smart", "full" ]
    		 Yes "smart" The type of history you would like to see, either smart or full. Smart use rules to combine similar consecutive items, full will not.
    REDPath URI-Path string
    minLength: 1
    pattern: ^[a-zA-Z0-9\[\]\.]+$
    		 No The REDPath you want to replay
    scenario URI-Query string
    maxLength: 24
    pattern: ^[a-zA-Z0-9]*$
    		 Yes "" the scenario you want to replay for
    toTs URI-Query float Yes null The timestamp (with microseconds until which you want your history to run), needed to get previous entries, by default you simply get the latest
    count URI-Query int
    max: 100
    		 Yes 20 The amount of history-items to retrieve
    Response HTTP Type Description
    Success 200 HistoryItem[] Values of this REDPath when it changed value, but aggregated in a smart way.
    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 Requires: ('red:*' OR 'red:read') ⎘
    Authentication schemes (Click an authentication scheme to expand it)
    JWTAuth
    Result wrappers (Click a result-wrapper to expand it)
    Success
    Error