Homepage

API Documentation link

linkList products

This may not return a complete list of products or may include products for which the update server does not provide updates for.

URL Structure
api/products/
Method

GET

Returns

List of products, including meta data

The "product_name" may be empty or missing entirely.

http/1.1 200 OK Content-Type: application/json; charset=utf-8
[
  {
    "product_id": "private_blog",
    "product_name": "Private Blog"
  },
  {
    "product_id": "vp_typekit"
  }
]

linkCreate product

This method is protected and an api_key with the neccessary permissions is required to use it.

URL Structure
api/products/
Method

POST

Parameters

product_id (optional)
The ID of the product. Must be unique and contain at least 3 lowercase letters or underscores. If ommitted a random one will be assigned.

product_name (optional)
The friendly name of the product e.g. "Private Blog"

Returns

The metadata for the created product.

Creating a product using the same "product_id" as a recently deleted product may fail.

http/1.1 200 OK Content-Type: application/json; charset=utf-8

{
  "product_id": "private_blog",
  "product_name": "Private Blog"
}

linkGet product

URL Structure
api/products/:product_id/
Method

GET

Returns

The metadata for the product.

http/1.1 200 OK Content-Type: application/json; charset=utf-8

{
  "product_id": "private_blog",
  "product_name": "Private Blog"
}

linkUpdate product

This method is protected and an api_key with the neccessary permissions is required to use it.

URL Structure
api/products/:product_id/
Method

PUT

Parameters

api_key (required)

Returns

The metadata for the updated product.

http/1.1 200 OK Content-Type: application/json; charset=utf-8

{
  "product_id": "private_blog",
  "product_name": "Private Blog"
}

linkList Channels

URL Structure
api/channels/
Method

GET

Parameters

api_key (optional)

product_id (optional)

If using an api_key this can be ommited (displays channels for every product).

The id of the product to list the channels for.

license_key (optional)

A license key is required to retrieve custom channels which are only available to certain customers.

Returns

List of channels, including meta data

The "channel_name", "channel_description", "alias_for", "is_core", "is_alias", "is_favourite" and "active_build" fields may be empty or mising entirely.

http/1.1 200 OK Content-Type: application/json; charset=utf-8

[
  {
    "channel_id": "stable",
    "channel_name": "Stable Channel",
    "channel_description": "Updates are pushed only when thoroughly tested to minimize risk of an update which adversely affects a site.",
    "product": "private_blog",
    "is_core": true,
    "is_alias":  false,
    "is_favourite": false,
    "active_build": "7rxwO2vRik93do5mdiep91500M29xCMJ"
  },
  {
    "channel_id": "development",
    "channel_name": "Development Channel",
    "channel_description": "Updates are pushed early in the development cycle, being on the bleeding edge means that there is an increased risk of instability.",
    "product": "private_blog",
    "is_core": true,
    "is_alias":  false,
    "is_favourite": false,
    "active_build": "2vRik93do5mdiep91500M29xCMJ7rxwO"
  },
  {
    "channel_id": "d_mahler",
    "channel_name": "David Mahler Custom Channel",
    "customer_id": "93do5mdiep91500M29xCMJ7rxwO2vRik",
    "product": "private_blog",
    "is_core": false,
    "is_alias":  true,
    "alias_for": "development",
    "is_favourite": true,
    "active_build": "91500M29xCMJ7rxwO2vRik93do5mdiep"
  }
]

If you are having issues or want more information regarding this service please shoot me an email.