Scheduler API

Scheduler API is used to manage the schedules for agents. Use this API to create new schedule using CRON expression to start jobs automatically on pre-defined time or recurring.

Schedule the agent

This API will schedule the agent as per given cron expression.

Endpoint:

Method: POST
URL: https://api.agenty.com/v1/scheduler/{{AGENT_ID}}

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}} Your api key

Body:

{"cron_expression":"0 0 8 1/1 * ? *"}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "Agent with id : 7229mv10op scheduled successfully"
}

Delete the schedule

This API will remove the agent schedule permanently.

Endpoint:

Method: DELETE
URL: https://api.agenty.com/v1/scheduler/{{AGENT_ID}}

Headers:

Key Value Description
Content-Type application/json

Query params:

Key Value Description
apikey {{API_KEY}} Your api key

Body:

{"cron_expression":"0 0 8 1/1 * ? *"}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "Schedule deleted successfully for agent with id : 7229mv10op"
}