io.apiman.manager.api.rest.contract

Interface ISystemResource

@Path(value="system")
public interface ISystemResource

A simple System API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.system.SystemStatusBean	getStatus() This endpoint simply returns the status of the apiman system.

Method Detail

getStatus

@GET
@Path(value="status")
@Produces(value="application/json")
io.apiman.manager.api.beans.system.SystemStatusBean getStatus()

This endpoint simply returns the status of the apiman system. This is a useful endpoint to use when testing a client's connection to the apiman API Manager REST services.

Returns:

System status information.