API Routes

For a full reference and interactive documentation go to Settings > Common System Settings > API Whitelist > API Documentation

Base URL: your-lucy-url.tld/api

Authentication

Route	Protocol	Descriptiom
/auth	POST	Client authentication

Language

Route	Protocol	Description
/languages	GET	Get all language IDs
/languages/{id}	GET	Get a language

Users

Route	Protocol	Description
/users	PUT	Create a user

Client

Route	Protocol	Description
/clients	GET	Get all clients
/clients	PUT	Create a client
/clients/:id	GET	Get a client
/clients/:id	POST	Update a client
/clients/:id	DELETE	Delete a client

Scenario Templates

Route	Protocol	Description
/scenario-templates	GET	Get all scenario templates
/scenario-templates/{id}	GET	Get a scenario template
/scenario-templates/{id}	DELETE	Delete a scenario template
/scenario-templates/landing	POST	Update the template's landing page content

Awareness Templates

Route	Protocol	Description
/awareness-templates	GET	Get all awareness templates
/awareness-templates/{id}	GET	Get an awareness template
/awareness-templates/{id}	DELETE	Delete an awareness template
/awareness-templates/file	POST	Update the awareness template's page content

Attachment Templates

Route	Protocol	Description
/attachment-templates	GET	Get all attachment templates
/attachment-templates/{id}	GET	Get an attachment template
/attachment-templates/{id}	DELETE	Delete an attachment template
/attachment-templates/variables/{id}	GET	Get all variables for an attachment template

Report Templates

Route	Protocol	Description
/report-templates	GET	Get all report templates
/report-templates/{id}	GET	Get a report template

Campaign Templates

Route	Protocol	Description
/campaigns/templates	GET	Get all campaign templates

Recipient Groups

Route	Protocol	Description
/recipient-groups	GET	Get all recipient groups
/recipient-groups	PUT	Create a recipient group
/recipient-groups/{id}	GET	Get a recipient group
/recipient-groups/{id}	POST	Update details for a recipient group
/recipient-groups/{id}	DELETE	Delete a recipient group
/campaigns/{id}/recipient-groups	GET	Get all recipient groups from a campaign
/campaigns/{id}/recipient-groups	PUT	Add a recipient group to a campaign
/campaigns/{id}/recipient-groups/status	GET	Get the status of the recipient group in a campaign
/campaigns/{id}/recipient-groups	DELETE	Remove a recipient group from a campaign
/scenarios/{id}/recipient-groups/{group}	GET	Get all recipient groups for a scenario
/scenarios/{id}/recipient-groups/{group}	PUT	Add a recipient group to a scenario
/scenarios/{id}/recipient-groups/{group}	DELETE	Remove a recipient group from a scenario

Recipients

Route	Protocol	Description
/recipients/{id}	GET	Get a recipient
/recipients/{id}	POST	Update a recipient
/recipients/{id}	DELETE	Delete a recipient
/recipients/{id}/stats	GET	Get recipient stats
/recipient-groups/{id}/recipients	GET	Get all recipients in a group
/recipient-groups/{id}/recipients	PUT	Add a recipient to a group
/recipient-groups/{id}/recipients/{externaID}	GET
/recipient-groups/{id}/recipients/{externaID}	POST
/recipient-groups/{id}/recipients/{externaID}	DELETE
/export/campaign/{id}/recipients	POST	Export recipients from a campaign to a new group

Recipient Custom Fields

Route	Protocol	Description
/recipient-custom-fields	GET	Get all custom fields
/recipient-custom-fields	PUT	Create a custom field
/recipient-custom-fields/{id}	GET	Get a custom field
/recipient-custom-fields/{id}	POST	Update a custom field
/recipient-custom-fields/{id}	DELETE	Delete a custom field

Campaigns

Route	Protocol	Description
/campaigns	GET	Get all campaigns
/campaigns	PUT	Create a campaign
/campaigns/{id}	GET	Get a campaign
/campaigns/{id}	POST	Update a campaign
/campaigns/{id}	DELETE	Delete a campaign
/campaigns/{id}/status	POST	Update campaign status
/campaigns/{id}/test-run	POST	Start the test run for a campaign
/campaigns/{id}/run-checks	POST	Start the pre-campaign checks for a campaign
/campaigns/{id}/copy	POST	Copy a campaign
/campaigns/{id}/stats	GET	Get stats for a campaign
/campaigns/{id}/errors	GET	Get errors for a campaign

Scenarios

Route	Protocol	Description
/campaigns/{id}/scenarios	GET	Get all scenarios from a campaign
/campaigns/{id}/scenarios	PUT	Add a scenario to a campaign
/campaigns/scenario/website	POST	Update the scenario's website content
/scenarios/{id}	GET	Get a camp[aign scenario
/scenarios/{id}	POST	Update a campaign scenario
/scenarios/{id}	DELETE	Delete a campaign scenario
/scenarios/{id}/message	POST	Update a campaign scenario email
/scenarios/{id}/upload-eml	POST	Update a campaign scenario email with an EML file

Awareness

Route	Protocol	Description
/campaigns/{id}/awareness	GET	Get all awareness from a campaign
/campaigns/{id}/awareness	PUT	Add an awareness to a campaign
/campaigns/awareness/website	POST	Update the website content for an awareness
/awareness/{id}	GET	Get an awareness
/awareness/{id}	POST	Update an awareness
/awareness/{id}	DELETE	Delete an awareness
/awareness/{id}/message	POST	Update the email content for an awareness
/awareness/{id}/bind-scenario	POST	Bind an awreness to a scenario
/awareness/{id}/unbind-scenario	POST	Unbind an awareness from a scenario

Campaign Custom Fields

Route	Protocol	Description
/campaign-custom-fields	GET	Get all custom fields
/campaign-custom-fields	PUT	Create a custom field
/campaign-custom-fields/{id}	GET	Get a custom field
/campaign-custom-fields/{id}	POST	Update a custom field
/campaign-custom-fields/{id}	DELETE	Delete a custom field

Campaign Reports

Route	Protocol	Description
/campaigns/{id}/report	POST	Create a report
/reports/{id}	GET	Get a report
/reports/{id}/download	GET	Download a report

Scheduler

Route	Protocol	Description
/campaigns/{id}/schedule-rules	GET	Get all schedules rules for a campaign
/campaigns/{id}/schedule-rules	PUT	Add a schedule rule to a campaign
/schedule-rules/{id}	GET	Get a schedule rule
/schedule-rules/{id}	POST	Update a schedule rule
/schedule-rules/{id}	DELETE	Delete a schedule rule
/schedule-rules/{id}/recipient-groups	GET	Get the recipient groups for a schedule rule
/schedule-rules/{id}/scenarios	GET	Get the scenarios for a schedule rule
/campaigns/{id}/schedule-plan/generate	POST	Generate a schedule plan from a schedule rule
/campaigns/{id}/schedule-plan/status	GET	Get the status of a schedule plan
/campaigns/{id}/schedule-plan	GET	Get a schedule plan

Victims

Route	Protocol	Description
/campaigns/{id}/victims	GET	Get all victims from a campaign
/scenarios/{id}/victims	GET	Get all victims for a campaign scenario
/victims/{id}	GET	Get a victim
/victims/{id}/custom-field	POST	Update a victim's custom fields
/campaigns/victims/{id}/re-send/{type}	POST	Re-send scenario or awareness for a victim

Diplomas

Route	Protocol	Description
/awareness-certificates/generate	POST	Generate a diploma for all recipients in a campaign
/awareness-certificate/{id}	GET	Get a diploma
/awareness-certificates/download/{id}	GET	Download a diploma

Exports

Route	Protocol	Description
/export/{id}	GET	Get an export
/export/generate	POST	Create a campaign export
/export/download/{id}	GET	Download an export

Benchmarks

Route	Protocol	Description
/benchmarks	GET	Get all benchmarks
/benchmarks	PUT	Create a benchmark
/benchmarks/{id}	GET	Get a benchmark
/benchmarks/{id}	POST	Update a benchmark
/benchmarks{id}	DELETE	Delete a benchmark

Domains

Route	Protocol	Description
/domains	GET	Get all domains
/domains	PUT	Add a domain
/domains/{id}	DELETE	Delete a domain

Incidents

Route	Protocol	Description
/incidents	GET	Get all incidents
/incidents/{id}	GET	Get an incident
/incidents/{id}	DELETE	Delete an incident
/incidents/{id}/message	GET	Get the message content for an incident
/incidents/{id}/headers	GET	Get the message headers for an incident
/incidents/{id}/abuse-modla-data	GET	Get the abuse data for an incident
/incidents/{id}/send-abuse	POST	Send an abuse report for an incident

System

Route	Protocol	Description
/system/whitelabel	POST	Update whitelabel settings
/system/whitelabel/logo	POST	Upload logo
/system/monitoring	GET	Get system monitoring data
/version	GET	Get the current software version