IAF management API
Apama management API for IAF
Version: 10.15.0.2
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
Retrieve summary information about the IAF. (iafStatusGet)
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
[ Jump to Methods ]
Table of Contents