Package org.jclouds.profitbricks.features

Interface ServerApi

  • @Consumes("text/xml")
@Produces("text/xml")
public interface ServerApi

    • Method Detail

      • getAllServers

        @POST
@Named("server:getall")
List<Server> getAllServers()
        Returns:
        Returns information about all virtual server, such as configuration, provisioning status, power status, etc.

      • getServer

        @POST
@Named("server:get")
Server getServer​(String identifier)
        Parameters:
        identifier - Identifier of the virtual server
        Returns:
        Returns information about a virtual server, such as configuration, provisioning status, power status, etc.

      • startServer

        @POST
@Named("server:start")
String startServer​(String id)
        Starts an existing virtual server
        • Server may receive new public IP addresses if necessary
        • Billing will continue
        Parameters:
        id - Identifier of the target virtual server
        Returns:
        Identifier of current request

      • stopServer

        @POST
@Named("server:stop")
String stopServer​(String id)
        Stops an existing virtual server forcefully (HARD stop)
        • Server will be forcefully powered off. Any unsaved data may be lost!
        • Billing for this server will be stopped
        • When restarting the server a new public IP gets assigned, alternatively, you can reserve IP addresses, see reservation of public IP blocks
        A graceful stop of a server is not possible through the ProfitBricks API. We recommend to access and execute the command on the virtual server directly. Once the server was shutdown you still can use the "stopServer" method that will stop billing.
        Parameters:
        id - Identifier of the target virtual server
        Returns:
        Identifier of current request

      • resetServer

        @POST
@Named("server:reset")
String resetServer​(String id)
        Resets an existing virtual server (POWER CYCLE).
        • Server will be forcefully powered off and restarted immediately. Any unsaved data may be lost!
        • Billing will continue
        Graceful REBOOT A graceful reboot of a server is not possible through the ProfitBricks API. We recommend to access and execute the command on the virtual server directly.
        Parameters:
        id - Identifier of the target virtual server
        Returns:
        Identifier of current request

      • createServer

        @POST
@Named("server:create")
String createServer​(Server.Request.CreatePayload payload)
        Creates a Virtual Server within an existing data center. Parameters can be specified to set up a boot device and connect the server to an existing LAN or the Internet.
        Parameters:
        payload - Payload
        Returns:
        serverId of the created server

      • updateServer

        @POST
@Named("server:update")
String updateServer​(Server.Request.UpdatePayload payload)
        Updates parameters of an existing virtual server device.
        Parameters:
        payload - Payload
        Returns:
        Identifier of current request

      • deleteServer

        @POST
@Named("server:delete")
boolean deleteServer​(String id)
        Deletes an existing Virtual Server.
        Parameters:
        id - Identifier of the target virtual server
        Returns:
        Identifier of current request