Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuclei automations API

The automations API from Nuclei — 2 operation(s) for automations.

Nuclei automations API is one of 36 APIs that Nuclei publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include automations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 3 base URLs: https://api.projectdiscovery.io, https://api.dev.projectdiscovery.io, http://localhost:8085.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.projectdiscovery.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nuclei automations API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (X-API-Key). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

automations 5
GET
/v1/automations
Get Automations
get-v1-automations 3 params → 200400401500default
POST
/v1/automations
Create Automation
post-v1-automations 1 param body → 200201400401500
GET
/v1/automations/{event}
Get Automation
get-v1-automations-event 2 params → 200400401404500default
PATCH
/v1/automations/{event}
Update Automation
patch-v1-automations-event 2 params body → 200400401404500default
DELETE
/v1/automations/{event}
Delete Automation
delete-v1-automations-event 2 params → 200400401404500default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AutomationScanData (21 properties), GetAutomationItem (7 properties), GetAutomationsListItem (5 properties), EnumerationIds (1 property). Each schema is shown below with its type and property counts.

EnumerationIds
object
1 property 1 required
GetAutomationsListItem
object
5 properties 5 required
AutomationScanData
object
21 properties
GetAutomationItem
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-automations-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

Nuclei agents API
Nuclei Asset API
Nuclei assets API
Nuclei billing API
Nuclei chaos API
Nuclei configurations API
Nuclei deprecated API
Nuclei domains API
Nuclei elog API
Nuclei enumeration API
Nuclei enumerations API