API

API Version Log

From GoGrid

Version 1.5

Version 1.5 includes the ability to manage resources in multiple datacenters. This is represented in the API by a new datacenter method parameter and object attribute, as specified below.

API Methods

The following API list methods have been updated to accept an optional datacenter parameter:

The common.lookup.list method has also been updated to accept a new datacenter lookup value.

To list valid datacenter values, call common.lookup.list with lookup set to datacenter.

API Objects

The following objects have been updated to include a new datacenter attribute

Version 1.4

API Methods

Version 1.4 includes a method to edit the real IP pool membership of a Load Balancer

Load Balancer Methods

grid.loadbalancer.edit

API function call to edit the real IP pool membership of a Load Balancer

Version 1.3

Version 1.3 includes server image management methods to edit, delete, restore and get a single server image object along with some updates to the billing summary object.

API Methods

Server Image Methods

grid.image.get

API function call to get a server image object.

grid.image.edit

API function call to edit the friendly name and description of a server image.

grid.image.delete

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

grid.image.restore

API function call to restore a server image from the trash.

API Objects

Billing Summary (Object)

The Billing Summary Object has been updated with parameters for:

gbHours - Projected RAM GB Hrs that will be used in current billing period.
ramOverage - Projected total of dollars spent on RAM overages in current billing period in $.
ramTotal - Projected total of dollars spent on RAM in current billing period in $.
gbTransfer - Projected Transfer in GB that will be used in current billing period.
transferOverage - Projected total of dollars spent on Transfer overages in current billing period in $.
transferTotal - Projected total of dollars spent on Transfer in current billing period in $.

Version 1.2

Version 1.2 includes the ability to save a server image from an image sandbox server. This feature includes a new API method and modifications to some objects. The following objects have been updated with new attributes to support this feature:

API Objects

Server Image (Object)

The Server Image Object has been updated with parameters for:

owner - The owner of this image. This is the company who produced this image.

Customer (Object)

The Customer Object has been added to the API with parameters for:

id - A unique identifier for this customer. This is auto-generated by the system.
name - A friendly name for this customer. Input and set when signing up.

Server (Object)

The Server Object has been updated with parameters for:

isSandbox - Is this server an image sandbox? Boolean options for true and false.

API Methods

Server Image Methods

grid.image.save

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

Version 1.1

Version 1.1 does not include any new methods or objects. The following objects have been updated with new attributes. These attributes are only accessible if HTTPS requests specify version 1.1 of the API:

API Objects

Server Image (Object)

The Server Image Object has been updated with parameters for:

architecture - OS Architecture of the server image, i.e. 32-bit or 64-bit. To list option values, call common.lookup.list with lookup set to image.architecture.
type - The image's server type, i.e. web/app vs. database server. Same values as server.type. To list option values, call common.lookup.list with lookup set to image.type.
state - State of the server image, i.e. enabled or disabled. To list option values, call common.lookup.list with lookup set to image.state.
price - Price per instance in US dollars.
billingTokens - The billing tokens associated to this image.

IP (Object)

The IP Object has been updated with parameters for:

state - The state of this IP, i.e. assigned or unassigned. To list option values, call common.lookup.list with lookup set to ip.state.

Billing Summary (Object)

The Billing Summary Object has been updated with parameters for:

startTimestamp - The timestamp of the current billing start date. Timestamp is a UNIX timestamp which reflects the number of milliseconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).
endTimestamp - The timestamp of the current billing end date. Timestamp is a UNIX timestamp which reflects the number of milliseconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).