API

API

From GoGrid



Contents

Welcome to the GoGrid API Wiki. Check out the Getting Started Guide below for an overview of the API. When you are ready to start coding take a look at the pages under Language Resources to see how to use the API in your favorite language.

The current version of the GoGrid API is 1.4.

Start Here


Language Resources

REST Interface

The GoGrid API is a REST-like Query interface. GoGrid method calls are made over the internet by sending HTTPS GET or POST requests to the GoGrid API REST Server. Nearly any computer language can be used to communicate over HTTPS with the REST server. Browse our Getting started guide for more documentation regarding making API calls from different languages such as Java, PHP, Python, Perl, Ruby, C#, or even shell scripting languages such as bash.

API Methods

Job Methods

grid.job.list   

API function call to list jobs in your grid.

grid.job.get   

API function call to retrieve a single job in your grid.

Load Balancer Methods

grid.loadbalancer.list   

API function call to list load balancers in your grid.

grid.loadbalancer.get   

API function call to retrieve a single load balancer in your grid.

grid.loadbalancer.add   

API function call to add a load balancer to your grid.

grid.loadbalancer.edit            

API function call to edit a load balancer on your grid.

grid.loadbalancer.delete   

API function call to delete a load balancer and remove it from your grid.

Server Methods

grid.server.list   

API function call to list servers in your grid.

grid.server.get   

API function call to retrieve a single server in your grid.

grid.server.add   

API function call to add a servers to your grid.

grid.server.delete   

API function call to delete a server and remove it from your grid.

grid.server.power   

API function call to start, stop, or restart a server.

Server Image Methods

grid.image.list   

API function call to list all available images.

grid.image.get            

API function call to retrieve a single server image.

grid.image.edit            

API function call to edit a single server image.

grid.image.save            

API function call to save a server image from an image sandbox.

grid.image.delete            

API function call to delete a server image and send it to trash.

grid.image.restore            

API function call to restore a server image from trash.

IP Methods

grid.ip.list   

API function call to list all, assigned, unassigned, public, or private ips.

Passwords Methods

support.password.list   

API function call to list all passwords in the system or for a particular server.

support.password.get   

API function call to get a password object.

Billing Methods

myaccount.billing.get   

API function get the billing summary data for this account.

Utility Methods

common.lookup.list   

Generic API function call to list the valid options for a particular lookup.

This cloudcenter API OpenSpec by GoGrid is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.

Clarifications and Permissions beyond the scope of this license may be available at www.gogrid.com/api-specification-license.

Retrieved from "http://wiki.gogrid.com/wiki/index.php/API:API"
Personal tools