correlator management API
Apama management API for correlator
Version: 10.11.3.3
BasePath:/
All rights reserved
https://www.apamacommunity.com/terms-conditions/
Access
[ Jump to Models ]
Table of Contents
Retrieve the connections to the component. (connectionsGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Check if the component is running. (deepPingGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Object
400
Error
Object
Retrieve the arguments that were specified when the component was started. (infoArgvGet)
Return type
array[Object]
Example data
Content-Type: application/json
[ { }, { } ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
400
Error
Object
Retrieve the list of other categories available under /info on this component. (infoCategoriesGet)
Return type
array[Object]
Example data
Content-Type: application/json
[ { }, { } ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
400
Error
Object
Retrieve the names and values of the environment variables in use. (infoEnvpGet)
Return type
array[Object]
Example data
Content-Type: application/json
[ { }, { } ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
400
Error
Object
Summary information about the component including its name, version, etc. (infoGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Retrieve component-specific status information. (infoStatsGet)
Return type
array[Object]
Example data
Content-Type: application/json
[ { }, { } ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
400
Error
Object
Retrieve the current log level of the component. (logLevelGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Change the log level of the component. (logLevelPut)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Object
400
Error
Object
Check if the component is running. (pingGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Object
400
Error
Object
Up
get /correlator/appLogging
Retrieve the EPL logging categories and levels. (correlatorAppLoggingGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Retrieve information about the state of the correlator. (correlatorInfoGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Up
get /correlator/status
Retrieve the runtime status of the correlator including user-defined status values. (correlatorStatusGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Retrieve a description of all the event types defined in the correlator. (correlatorTypesGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Retrieve information about the license status of the correlator and what restrictions apply. (infoLicenseGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xmlapplication/jsonexamples
Responses
200
OK
Object
400
Error
Object
Perform a request on the correlator and get the response. The request has a single parameter 'args' which is a list of strings of the request. (requestPut)
Responses
200
OK
400
Error
[ Jump to Methods ]
Table of Contents