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 agents API

The agents API from Nuclei — 4 operation(s) for agents.

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

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

This API exposes 6 operations across 4 paths, and defines 2 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.

6 operations 4 paths 2 schemas 2 GET1 PATCH3 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 agents 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 6

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

agents 6
POST
/v1/agents/in
Register Agents
post-v1-agents-in 9 params → 200404
POST
/v1/agents/out
Deregister Agent
post-v1-agents-out 2 params → 200404
GET
/v1/agents
Get Agents
get-v1-agents 1 param → 200400401404500default
PATCH
/v1/agents
Bulk Update Agents
patch-v1-agents 1 param body → 200400404
GET
/v1/agents/{id}
Get Agent by ID
get-v1-agents-id 2 params → 200404
POST
/v1/agents/{id}
Update Agent
post-v1-agents-id 2 params body → 200400404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is AgentItem (15 properties). Each schema is shown below with its type and property counts.

AgentItem
object
15 properties 11 required
Agents
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-agents-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

Nuclei Asset API
Nuclei assets API
Nuclei automations 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