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

The users API from Nuclei — 12 operation(s) for users.

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

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

This API exposes 17 operations across 12 paths, and defines 3 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.

17 operations 12 paths 3 schemas 2 DELETE7 GET1 PATCH7 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 users 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 17

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

users 17
POST
/v1/user/feedback
Create Feedback
post-v1-user-feedback 1 param body → 200401500default
POST
/v1/user/delete/code
Email user deletion verification code
post-v1-user-delete-code 1 param → 200400403500default
GET
/v1/user
Get User Profile
get-v1-user 1 param → 200401500default
DELETE
/v1/user
Delete user from system along with all data
delete-v1-user 1 param body → 200400403500default
GET
/v1/user/apikey
Get API Key
get-v1-user-apikey → 200400401404500default
POST
/v1/user/apikey
Create API Key
post-v1-user-apikey → 200400401404500default
DELETE
/v1/user/apikey
Delete API Key
delete-v1-user-apikey → 200400401404500default
GET
/v1/user/onboarding_status
Get User Setup Statistics
get-v1-user-setup-stats → 200400401500default
GET
/v1/user/billing_assets
Get Billing Assets details
get-v1-user-billing-assets → 200400401500default
GET
/v1/user/promo_code
Get Promocode Details
get-v1-user-promocode 1 param → 200400401500default
POST
/v1/user/promo_code
Apply Promocode
post-v1-user-promocode body → 200400401404500default
POST
/v1/user/apikey/rotate
Rotate API Key
post-v1-user-apikey-rotate → 200400401404500default
POST
/v1/user/domain-verification/request
Request Domain Verification
post-v1-user-domain-verification-request 1 param body → 200400401429500default
POST
/v1/user/domain-verification/confirm
Confirm Domain Verification
post-v1-user-domain-verification-confirm 1 param body → 200400401404500default
GET
/v1/user/domain-verification/status
Get Domain Verification Status
get-v1-user-domain-verification-status 1 param → 200401500default
GET
/v1/user/subscription
Get Subscription Status
get-v1-user-subscription 1 param → 200400500default
PATCH
/v1/user/subscription
Update current subscription
patch-v1-user-subscription 1 param body → 200400403500default

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UserWorkspaces (7 properties), DomainVerificationRequest (7 properties). Each schema is shown below with its type and property counts.

DomainVerificationRequest
object
7 properties 4 required
DomainVerificationType
UserWorkspaces
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-users-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

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