API Reference

Complete API documentation for integrating with Cronium programmatically.

Authentication

Cronium uses API tokens for authentication. All API requests must include a valid API token in the Authorization header.

Creating API Keys

Generate API tokens to access the Cronium API programmatically.

Step 1: Navigate to API Settings

Go to your account settings and select the "API Tokens" tab.

Step 2: Create New Token

Click "Create New Token" and provide a descriptive name for your token.

Step 3: Set Permissions

Choose the appropriate permissions for your use case:

Read: View events, workflows, and logs
Write: Create and modify events and workflows
Execute: Trigger events and workflows
Admin: Full access to all resources

Step 4: Copy Your Token

Copy the generated token immediately. For security reasons, you won't be able to view it again.

Using API Keys

Include your API token in the Authorization header of every request:

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://your-cronium-instance.com/api/events',
    headers=headers
)

Events API

The Events API allows you to manage and execute automated scripts and events.

Workflows API

The Workflows API allows you to create and manage complex automation workflows with multiple events and conditional logic.

Servers API

Variables API

The Variables API allows you to manage user-scoped key-value pairs that can be accessed in your scripts using the cronium.getVariable() and cronium.setVariable() runtime helpers. Variables are encrypted at rest and scoped to the authenticated user.

Using Variables in Scripts

Variables created via the API can be accessed in your scripts using runtime helpers:

// Node.js
const dbUrl = cronium.getVariable('DATABASE_URL');
cronium.setVariable('LAST_RUN', new Date().toISOString());

# Python
db_url = cronium.getVariable('DATABASE_URL')
cronium.setVariable('LAST_RUN', datetime.now().isoformat())

# Bash
DB_URL=$(cronium.getVariable "DATABASE_URL")
cronium.setVariable "LAST_RUN" "$(date -Iseconds)"

Response Formats

Standard Response Format

All API responses follow a consistent format:

{
  "success": true,
  "data": {
    // Response data here
  },
  "message": "Operation completed successfully",
  "timestamp": "2024-01-20T16:00:00Z"
}

Error Handling

Error Response Format

Error responses include detailed information to help with debugging:

{
  "error": "Validation Error",
  "message": "Invalid request data",
  "code": 400,
  "details": [
    {
      "field": "name",
      "message": "Name is required"
    },
    {
      "field": "type", 
      "message": "Type must be one of: BASH, PYTHON, NODEJS, HTTP_REQUEST"
    }
  ],
  "timestamp": "2024-01-20T16:15:00Z"
}

HTTP Status Codes

200

Success

201

Created

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid API token

403

Forbidden - Insufficient permissions

404

Not Found - Resource doesn't exist

429

Rate Limited - Too many requests

500

Internal Server Error

API Reference

Complete API documentation for integrating with Cronium programmatically.

Authentication

Cronium uses API tokens for authentication. All API requests must include a valid API token in the Authorization header.

Creating API Keys

Generate API tokens to access the Cronium API programmatically.

Step 1: Navigate to API Settings

Go to your account settings and select the "API Tokens" tab.

Step 2: Create New Token

Click "Create New Token" and provide a descriptive name for your token.

Step 3: Set Permissions

Choose the appropriate permissions for your use case:

Read: View events, workflows, and logs
Write: Create and modify events and workflows
Execute: Trigger events and workflows
Admin: Full access to all resources

Step 4: Copy Your Token

Copy the generated token immediately. For security reasons, you won't be able to view it again.

Using API Keys

Include your API token in the Authorization header of every request:

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://your-cronium-instance.com/api/events',
    headers=headers
)

Events API

The Events API allows you to manage and execute automated scripts and events.

Workflows API

The Workflows API allows you to create and manage complex automation workflows with multiple events and conditional logic.

Servers API

Variables API

Using Variables in Scripts

Variables created via the API can be accessed in your scripts using runtime helpers:

// Node.js
const dbUrl = cronium.getVariable('DATABASE_URL');
cronium.setVariable('LAST_RUN', new Date().toISOString());

# Python
db_url = cronium.getVariable('DATABASE_URL')
cronium.setVariable('LAST_RUN', datetime.now().isoformat())

# Bash
DB_URL=$(cronium.getVariable "DATABASE_URL")
cronium.setVariable "LAST_RUN" "$(date -Iseconds)"

Response Formats

Standard Response Format

All API responses follow a consistent format:

{
  "success": true,
  "data": {
    // Response data here
  },
  "message": "Operation completed successfully",
  "timestamp": "2024-01-20T16:00:00Z"
}

Error Handling

Error Response Format

Error responses include detailed information to help with debugging:

{
  "error": "Validation Error",
  "message": "Invalid request data",
  "code": 400,
  "details": [
    {
      "field": "name",
      "message": "Name is required"
    },
    {
      "field": "type", 
      "message": "Type must be one of: BASH, PYTHON, NODEJS, HTTP_REQUEST"
    }
  ],
  "timestamp": "2024-01-20T16:15:00Z"
}

HTTP Status Codes

200

Success

201

Created

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid API token

403

Forbidden - Insufficient permissions

404

Not Found - Resource doesn't exist

429

Rate Limited - Too many requests

500

Internal Server Error

API Reference

Authentication

Creating API Keys

Step 1: Navigate to API Settings

Step 2: Create New Token

Step 3: Set Permissions

Step 4: Copy Your Token

Using API Keys

Events API

GET/api/eventsRetrieve a list of all events

POST/api/eventsCreate a new event

GET/api/events/{id}Retrieve a specific event by ID

PATCH/api/events/{id}Update an existing event

DELETE/api/events/{id}Delete an event

GET/api/events/{id}/logsRetrieve logs for a specific event

POST/api/events/{id}/executeExecute an event immediately

Workflows API

GET/api/workflowsRetrieve a list of all workflows

GET/api/workflows/{id}Retrieve a specific workflow by ID with its nodes and connections

POST/api/workflowsCreate a new workflow with nodes and connections

PATCH/api/workflows/{id}Update an existing workflow

POST/api/workflows/{id}/executeExecute a workflow immediately

DELETE/api/workflows/{id}Delete a workflow and all its related data

Servers API

GET/api/serversRetrieve a list of all configured servers

Variables API

GET/api/variablesRetrieve all variables for the authenticated user

POST/api/variablesCreate a new variable

GET/api/variables/{key}Retrieve a specific variable by key

PUT/api/variables/{key}Update an existing variable

DELETE/api/variables/{key}Delete a variable

Using Variables in Scripts

Response Formats

Standard Response Format

Error Handling

Error Response Format

HTTP Status Codes

API Reference

Authentication

Creating API Keys

Step 1: Navigate to API Settings

Step 2: Create New Token

Step 3: Set Permissions

Step 4: Copy Your Token

Using API Keys

Events API

GET/api/eventsRetrieve a list of all events

POST/api/eventsCreate a new event

GET/api/events/{id}Retrieve a specific event by ID

PATCH/api/events/{id}Update an existing event

DELETE/api/events/{id}Delete an event

GET/api/events/{id}/logsRetrieve logs for a specific event

POST/api/events/{id}/executeExecute an event immediately

Workflows API

GET/api/workflowsRetrieve a list of all workflows

GET/api/workflows/{id}Retrieve a specific workflow by ID with its nodes and connections

POST/api/workflowsCreate a new workflow with nodes and connections

PATCH/api/workflows/{id}Update an existing workflow

POST/api/workflows/{id}/executeExecute a workflow immediately

DELETE/api/workflows/{id}Delete a workflow and all its related data

Servers API

GET/api/serversRetrieve a list of all configured servers

Variables API

GET/api/variablesRetrieve all variables for the authenticated user

POST/api/variablesCreate a new variable

GET/api/variables/{key}Retrieve a specific variable by key

PUT/api/variables/{key}Update an existing variable

DELETE/api/variables/{key}Delete a variable

Using Variables in Scripts

Response Formats

Standard Response Format

Error Handling

Error Response Format

HTTP Status Codes