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
    ErrorReporting Portal
    GET/portal ⎘
    ErrorReporting Portal main page showing summary of registered errors all services and per service.
    Parameter Location Type Requirements Optional Default value Description
    pastXdays URI-Query int Yes 0 Optional. If specified, only counts errors from the past lastXDays days.
    tsSince URI-Query int Yes 0 Optional. If specified, only counts since (and including) given timestamp. Ignores "lastXdays".
    Response HTTP Type Description
    Success 200 html Does not return a response; directly outputs HTML instead.
    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 scheme: JWTAuth Requires: None ⎘
    GET/portal/query ⎘
    ErrorReporting Portal page showing all errors within given criteria. Each entry links to the full report page.
    Parameter Location Type Requirements Optional Default value Description
    tsSince URI-Query int Yes 0 Optional. If specified, only includes registered errors since (and including) given timestamp.
    tsBefore URI-Query int Yes 0 Optional. If specified, only includes registered errors until (and including) given timestamp.
    service URI-Query string Yes "" Optional. If specified, only includes errors on given service.
    registeredErrorType URI-Query string Yes "" Optional. If specified, only includes errors of give registered error type.
    limit URI-Query int Yes 500 Optional. Maximum amount of items shown.
    Response HTTP Type Description
    Success 200 html Does not return a response; directly outputs HTML instead.
    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 scheme: JWTAuth Requires: None ⎘
    GET/portal/{idReport} ⎘
    Report display page through ErrorReporting Portal. This differs from /report/{idReport}/view in that this displays using a non-shareable URL that expires when the authorization expires.
    Parameter Location Type Requirements Optional Default value Description
    idReport URI-Path int No Report ID.
    Response HTTP Type Description
    Success 200 html Does not return a response; directly outputs HTML instead.
    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 scheme: JWTAuth Requires: None ⎘
    Registering
    POST/register ⎘
    Report an exception that occurred.
    Parameter Location Type Requirements Optional Default value Description
    errorReport POST-body string No JSON-encoded ErrorReport-model.
    mutualSecretHash POST-body string Yes null Only used as fallback in case Signed KateIntraService is not fully setup.
    Response HTTP Type Description
    Success 200 int Returns 0 if accepted (KateIntraService signature valid or MutualSecretHash valid); error number if unsigned and unaccepted or error-report had invalid JSON.
    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
      Unregistering
      GET/registeredErrors/services ⎘Authentication required
      Returns all (distinct) service names having registered errors.
      Response HTTP Type Description
      Success 200 string[] Array of service names
      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: 'kate:devops' ⎘
      GET/registeredErrors/{service} ⎘Authentication required
      Returns all (distinct) registered error types having registered errors.
      Parameter Location Type Requirements Optional Default value Description
      service URI-Path string No Service-name to filter on. Use "all" to return all registered error types regardless of service.
      Response HTTP Type Description
      Success 200 string[] Array of registered error types
      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: 'kate:devops' ⎘
      POST/unregister/byId/{idRegisteredError} ⎘Authentication required
      Unregister (delete/archive) a registered error. Can/should be used for resolved errors.
      Parameter Location Type Requirements Optional Default value Description
      idRegisteredError URI-Path int No ID of the registered error
      Response HTTP Type Description
      Success 200 bool Always 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 Requires: 'kate:devops' ⎘
      POST/unregister/byMultipleIds ⎘Authentication required
      Unregisters (delete/archive) one or more registered errors. Can/should be used for resolved errors.
      Parameter Location Type Requirements Optional Default value Description
      idRegisteredErrors POST-body int[] No IDs of the registered errors
      Response HTTP Type Description
      Success 200 bool Always 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 Requires: 'kate:devops' ⎘
      POST/unregister/byTime ⎘Authentication required
      Unregisters (delete/archive) all registered older than provided timestamp.
      Parameter Location Type Requirements Optional Default value Description
      timestamp POST-body int No Delete/archive all reports from before this timestamp.
      Response HTTP Type Description
      Success 200 int Returns amount unregistered.
      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: 'kate:devops' ⎘
      POST/unregister/byType ⎘Authentication required
      Unregisters (delete/archive) all registered errors of a certain type. Doing this by ID is strongly preferred; but this endpoint exists for errors having exorbitant quantities.
      Parameter Location Type Requirements Optional Default value Description
      serviceName POST-body string No Service name
      registeredTypes POST-body string[] No Registered type(s)
      Response HTTP Type Description
      Success 200 int Returns amount unregistered.
      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: 'kate:devops' ⎘
      Viewing
      GET/report/{idReport}/view ⎘
      Display a rendered error report.
      Parameter Location Type Requirements Optional Default value Description
      idReport URI-Path int No Report ID
      t URI-Query string No View token
      Response HTTP Type Description
      Success 200 html Does not return a response; directly outputs HTML instead.
      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