Controller Settings Methods

Get and set the controller configuration. The following is a glossary of the fields available through the API.

Controller Data

Zone Data

Table of Contents #

GET /controllers/{controller_id}/all.config #

Gets all the controller data fields, zone data, and custom schedule data in a single call.

Query Fields

  1. controller_id (string) - The id for the controller

Response

  1. controller_data - The controller data
  2. zones_data - The zones data for the controller in an array
$.ajax({
    type: 'GET',
    url: '[api url]/controllers/{controller_id}'
});

GET /controllers/{controller_id}/controller.config #

Gets all the controller data fields, zone data, and custom schedule data.

Query Fields

  1. controller_id (string) - The id for the controller

Response

  1. controller_data - The controller data
$.ajax({
    type: 'GET',
    url: '[api url]/controllers/{controller_id}'
});

PUT /controllers/{controller_id}/controller.config #

Update a controller's configuration

Query Fields

  1. controller_id (string) - The id for the controller

Post Fields

Any of the non read only controller data fields.

Response

  1. success (boolean) - The success of the call
$.ajax({
    type: 'PUT',
    url: '[api url]/controllers/{controller_id}',
    data: {
        "name": "new name"
    }
});

GET /controllers/{controller_id}/zone.config/{zone_num} #

Returns the controller current zone configuration settings

Query Fields

  1. controller_id (string) - The id for the controller
  2. zone_num (string) - The number of the zone

Response

The zone data for the given zone number.

$.ajax({
    type: 'GET',
    url: '[api url]/controllers/{controller_id}/zone.config/{zone_num}'
});

PUT /controllers/{controller_id}/zone.config/{zone_num} #

Update a specific zone of a controller.

Query Fields

  1. controller_id (string) - The public id for the controller

Post Fields

Any of the non read only zone data fields.

Response

  1. success (boolean) - The success of the call
$.ajax({
    type: 'PUT',
    url: '[api url]/controllers/{controller_id}/zone.config/{zone_num}',
    data: {
        "slope" : "slight"
    }
});