Package io.bdeploy.api.remote.v1

Interface PublicRootResource

@Path("/public/v1") @Consumes("application/json") @Produces("application/json") public interface PublicRootResource

  • Method Details

    • getVersion

      @GET @Path("/version") String getVersion()
      Returns:
      the currently running server version

    • login

      @Deprecated @GET @Path("/login") jakarta.ws.rs.core.Response login(@QueryParam("user") String user, @QueryParam("pass") String pass, @QueryParam("full") boolean full)
      Deprecated.
      Causes problems with encoding of query parameters with certain strong password values.
      Parameters:
      user - the user to log in
      pass - the password to use.
      full - whether a full authentication pack or only the token part is requested.
      Returns:
      Either a full authentication pack or a token only.

    • login2

      @POST @Path("/login2") jakarta.ws.rs.core.Response login2(CredentialsApi credentials, @QueryParam("full") boolean full)
      This new variant of the login method avoids query parameters to avoid issues with encoding.
      Parameters:
      credentials - the user and password DTO.
      full - whether a full authentication pack or only the token part is requested.
      Returns:
      Either a full authentication pack or a token only.

    • getSoftwareRepositories

      @GET @Path("/softwareRepositories") List<SoftwareRepositoryConfigurationApi> getSoftwareRepositories()
      Software repository hives contain additional software which can be referenced when building products.
      Returns:
      the list of available software repository hives on the master.

    • getInstanceGroups

      @GET @Path("/instanceGroups") List<InstanceGroupConfigurationApi> getInstanceGroups()
      Software repository hives contain additional software which can be referenced when building products.
      Returns:
      the list of available software repository hives on the master.

    • getInstanceGroupByInstanceId

      @GET @Path("/groupForInstance") InstanceGroupConfigurationApi getInstanceGroupByInstanceId(@QueryParam("instanceId") String instanceId)
      Parameters:
      instanceId - - the instance ID to get the instance group for.
      Returns:
      the InstanceGroupConfigurationApi of the instance group containing the instance with the given instance ID.

    • getInstanceResource

      @Path("/common") PublicInstanceResource getInstanceResource(@ActivityScope @QueryParam("BDeploy_group") String group)
      Returns a resource which can be used to query or access an instance.

      Common resource also available on the central master.

      Note: query parameter name must start with 'BDeploy_'

      Parameters:
      group - the instance group ID to get the instance resource for.
      Returns:
      the PublicInstanceResource to query information from.