Package io.bdeploy.api.remote.v1

Interface PublicInstanceResource

@Consumes("application/json")
@Produces("application/json")
public interface PublicInstanceResource

Method Summary

Modifier and Type	Method	Description
SortedMap<String,EndpointsConfigurationApi>	getAllEndpoints(String instanceId)
PublicProxyResource	getProxyResource(String instanceId, String applicationId)	Get a resource which allows to proxy various calls to the target application provided endpoint.
SortedMap<Manifest.Key,InstanceConfigurationApi>	listInstanceConfigurations(boolean latestOnly)	Returns a list of instance configurations available in this hive.

Method Details

listInstanceConfigurations

@GET
@Path("/instances")
SortedMap<Manifest.Key,InstanceConfigurationApi> listInstanceConfigurations(@QueryParam("latest")
 boolean latestOnly)

Returns a list of instance configurations available in this hive.

Returns:

the list of instance configurations.

getAllEndpoints

@GET
@Path("/endpoints")
SortedMap<String,EndpointsConfigurationApi> getAllEndpoints(@QueryParam("BDeploy_instance")
 String instanceId)

Parameters:

instanceId - the instance to query

Returns:

the list of endpoints provided by the product in the active instance version

getProxyResource

@Path("/proxy")
PublicProxyResource getProxyResource(@QueryParam("BDeploy_instance")
 String instanceId,
 @QueryParam("BDeploy_application")
 String applicationId)

Get a resource which allows to proxy various calls to the target application provided endpoint.

Note: query parameter name must start with 'BDeploy_'

Parameters:

instanceId - the instance ID

applicationId - the application ID