Package com.xebialabs.deployit.core.api

Interface EnvironmentService

@Path("/environment") @Produces("application/json") public interface EnvironmentService
Retrieves information about Environments: which DeployedApplications and which Hosts are there in an environment? A User must have READ permission on the environment to obtain the requested info.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId>
    getDeployedApplicationsByEnvironment(String envId, String deployedAppName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Finds DeployedApplications on an environment.
    List<com.xebialabs.deployit.engine.api.dto.DeploymentInfo>
    getHostsByEnvironment(String envId, String hostName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Finds Hosts that take part in the specified environment.

  • Method Details

    • getDeployedApplicationsByEnvironment

      @GET @Path("{id:.+}/deployed-applications") List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> getDeployedApplicationsByEnvironment(@PathParam("id") String envId, @QueryParam("deployedAppName") String deployedAppName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Finds DeployedApplications on an environment. Optionally (a part of) an application name can be specified to narrow your search results, e.g. specifying deployedAppName=Depl will find XL Deploy
      Parameters:
      envId - the environment ID to query
      deployedAppName - (Optional) (part of the) deployed application name to look for.
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results.
      Returns:
      a list of objects corresponding to deployed applications on the indicated environment

    • getHostsByEnvironment

      @GET @Path("{id:.+}/infrastructure") List<com.xebialabs.deployit.engine.api.dto.DeploymentInfo> getHostsByEnvironment(@PathParam("id") String envId, @QueryParam("name") String hostName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Finds Hosts that take part in the specified environment. Will return only hosts that the user has READ permission on. Optionally, (part of) a host name can be specified to narrow search results. A list of DeploymentInfo objects will be returned detailing the host ID, the host Type, and when and by whom a deployment to this host has taken place.
      Parameters:
      envId - the environment ID to query
      hostName - (Optional) (part of) the host name to look for
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects