Croniq User Guide

Getting Started

1. Sign Up: Register an account on the website.
2. Log In: Access your dashboard to manage tasks and view logs.
3. Get API Token: Use your email and password to obtain an API token for programmatic access.

API Authentication

Authenticate via API to manage your scheduled tasks programmatically. Obtain a token using your email and password:

curl -X POST https://your-croniq-domain.com/api/v1/auth \
  -H "Content-Type: application/json" \
  -d '{
  "email": "your@email.com",
  "password": "yourpassword"
}'

{
  "token": "YOUR_API_TOKEN"
}

Response:

{
  "token": "YOUR_API_TOKEN"
}

Use this token in the Authorization header for all API requests:

-H "Authorization: Basic YOUR_API_TOKEN"

Task Management API

You can create, list, update, and delete scheduled HTTP tasks via the API.

List Tasks

curl -X GET https://your-croniq-domain.com/api/v1/tasks \
  -H "Authorization: Basic YOUR_API_TOKEN"

Create Task

curl -X POST https://your-croniq-domain.com/api/v1/tasks \
  -H "Authorization: Basic YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "{\"foo\":\"bar\"}",
  "headers": {
    "Content-Type": "application/json"
  },
  "method": "POST",
  "name": "My API Call",
  "schedule": "* * * * *",
  "url": "https://api.example.com/endpoint"
}'

{
  "body": "{\"foo\":\"bar\"}",
  "headers": {
    "Content-Type": "application/json"
  },
  "method": "POST",
  "name": "My API Call",
  "schedule": "* * * * *",
  "url": "https://api.example.com/endpoint"
}

Get Task Details

curl -X GET https://your-croniq-domain.com/api/v1/tasks/TASK_ID \
  -H "Authorization: Basic YOUR_API_TOKEN"

Update Task

curl -X PUT https://your-croniq-domain.com/api/v1/tasks/TASK_ID \
  -H "Authorization: Basic YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "GET",
  "name": "Updated Name",
  "schedule": "*/5 * * * *",
  "url": "https://api.example.com/endpoint"
}'

{
  "method": "GET",
  "name": "Updated Name",
  "schedule": "*/5 * * * *",
  "url": "https://api.example.com/endpoint"
}

Delete Task

curl -X DELETE https://your-croniq-domain.com/api/v1/tasks/TASK_ID \
  -H "Authorization: Basic YOUR_API_TOKEN"

Logs & Monitoring

All HTTP requests and responses are logged. You can view execution history and details in your dashboard. For advanced users, API access to logs will be available soon.

Create a One-Time (Delayed) Task via API

You can create a one-time task that will be executed only once at the specified time. Use the following endpoint:

Create a Delayed Task

curl -X POST https://your-croniq-domain.com/api/v1/tasks/delayed \
  -H "Authorization: Basic YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "",
  "headers": {},
  "method": "POST",
  "name": "One-time task",
  "scheduled_at": "2024-07-01T18:00:00Z",
  "url": "https://example.com"
}'

Parameters:

• name — task name
• url — HTTP request URL
• method — HTTP method (GET, POST, PUT, DELETE)
• headers — request headers (JSON object)
• body — request body (optional)
• scheduled_at — execution time in ISO8601 format (UTC)

The response will contain the created task. The task will be executed only once at the specified time.

Support

If you have questions or need help, please contact our support team or open an issue on GitHub.
You can also contact us by email: a.ilaletdinov@yandex.ru.