group.*

group.list

List all groups under your account.

Parameters Bold parameters are required.

Name Type Description
token string Your API token

Response data

Result data will contains an array/collection of group data structure.

group.get

Get one group's information

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the group data structure.

Example response

{"data":{"id":1,"name":"example"},"info":[],"status":"success","code":0}

group.lookup

Search groups by exact name.

Parameters Bold parameters are required.

Name Type Description
token string Your API token
name string Group name

Response data

You'll get an array of group data structures.

Example response

{"data":[{"id":1,"name":"example"}],"info":[],"status":"success","code":0}

group.add

Add a new group

Parameters Bold parameters are required.

Name Type Description
token string Your API token
name string Name

Response data

You'll get the data structure of newly created group.

Example response

{"data":{"id":2,"name":"example"},"info":[],"status":"success","code":0}

group.edit

Update an existing group

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Group ID
name string Name

Response data

You'll get the structure of updated group.

group.delete

Delete a group

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of deleted group, with ID set to null.

group.vanish

Delete a group and all cronjobs under that group.

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of deleted group, with ID set to null.

group.empty

Keep the group and delete all cronjobs under that group.

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of the group.