Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET channels/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all channels in the system, with its main configuration data. If a stack is defined, the list will include all devices on that stack.
Resource URL
http://{host}/api/2.0/channels/config/.format
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|
GET channels/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single channel configuration view, specified by the required {id} parameter.
Resource URL
http://{host}/api/2.0/channels/config/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the desired channel. |
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|
POST channels/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new channel, configured according to the attached data request.
Resource URL
http://{host}/api/2.0/channels/config/.format
Example Request
POST
Expand |
---|
| |||||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
POST channels/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Copies a channel configuration to a new channel.
Resource URL
http://{host}/api/2.0/channels/config/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the channel to be copied. |
Example Request
POST
Expand | |||||
---|---|---|---|---|---|
| |||||
|
PUT channels/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a channel configuration.
Resource URL
http://{host}/api/2.0/channels/config/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The Id of the channel to be edited. |
Example Request
PUT
Expand | |
---|---|
|
| ||||||
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
|
DELETE channels/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific channel.
Resource URL
http://{host}/api/2.0/channels/config/{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the channel to be deleted. |
Example Request
DELETE
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Multi DELETE channels/config/.format?remove[]={id}&remove[]{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific multiple channel.
Resource URL
http://{host}/api/2.0/channels/config/.format?remove[]={id}&remove[]{id}/.format
Parameters
Parameter | Data Type | Description |
---|---|---|
id | integer | The ID of the channel to be deleted. |
Example Request
DELETE
4423552211/61Expand | |||||
---|---|---|---|---|---|
| |||||
|
GET channels/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by channel configuration.
Resource URL
http://{host}/api/2.0/channels/config/meta/.format
Example Request
GET
Expand | |||||
---|---|---|---|---|---|
| |||||
|