List all groups under your account.
Name | Type | Description |
---|---|---|
token | string | Your API token |
Result data contains an array/collection of group data structure.
Get one group's information
Name | Type | Description |
---|---|---|
token | string | Your API token |
id | integer | Group ID |
You'll get the group data structure.
{"data":{"id":1,"name":"example"},"info":[],"status":"success","code":0}
Search groups by exact name.
Name | Type | Description |
---|---|---|
token | string | Your API token |
name | string | Group name |
You'll get an array of group data structures.
{"data":[{"id":1,"name":"example"}],"info":[],"status":"success","code":0}
Add a new group
Name | Type | Description |
---|---|---|
token | string | Your API token |
name | string | Name |
autoDelete | integer | Automatically delete stopped (one-time) cronjobs. 0 for never; 1, 3, 7, 15, 30 for days. |
contacts | array|integer | One or an array of contact ID. |
You'll get the data structure of newly created group.
{"data":{"id":2,"name":"example"},"info":[],"status":"success","code":0}
Update an existing group
Name | Type | Description |
---|---|---|
token | string | Your API token |
id | integer | Group ID |
name | string | Name |
autoDelete | integer | Automatically delete stopped (one-time) cronjobs. 0 for never; 1, 3, 7, 15, 30 for days. |
contacts | array|integer | One or an array of contact ID. |
You'll get the structure of updated group.
List all cronjobs under a group.
Name | Type | Description |
---|---|---|
token | string | Your API token |
id | integer | Group ID |
Result data contains an array/collection of cronjob data structure.