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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nuclei

Nuclei internal API

The internal API from Nuclei — 33 operation(s) for internal.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

52 operations 33 paths 12 schemas 6 DELETE20 GET9 PATCH16 POST1 PUT

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 internal 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 52

Across 33 paths, the API surfaces 52 operations — 6 DELETE, 20 GET, 9 PATCH, 16 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

internal 52
GET
/v1/admin/user/search
Search user by name or email
get-v1-admin-user-search 5 params → 200400401500default
GET
/v1/admin/user/billing_assets
Get billing assets for a user
get-v1-admin-user-billing-assets 1 param → 200400401500default
GET
/v1/admin/user/audit_logs
Get audit logs for a user
get-v1-admin-user-audit-logs 7 params → 200400401500default
POST
/v1/admin/team/change_owner
change owner for a team (New owner will take control of the existing owner's subscription)
post-v1-admin-team-change_owner 1 param body → 200400401404500default
POST
/v1/admin/scan/token
Set Scan token for user
post-v1-admin-scan-token 2 params body → 200400401500default
PATCH
/v1/admin/scan/token
Update Scan token for user
patch-v1-admin-scan-token 1 param body → 200400401500default
GET
/v1/admin/scan/token
Get Token Usage (admin)
get-v1-admin-scan-token 3 params → 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
PATCH
/v1/admin/user/profile
Patch User Profile
patch-v1-admin-user-profile body → 200401500default
POST
/v1/admin/user/delete
Admin delete user
post-v1-admin-user-delete body → 200400403500default
POST
/v1/admin/users
Create New User
post-v1-admin-users body → 200400401500default
GET
/v1/user/team
Get Team
get-v1-user-team 1 param → 200401403500default
POST
/v1/user/team
Create Workspace
post-v1-user-team 1 param body → 200400401500default
PATCH
/v1/user/team
Update Team
patch-v1-user-team 1 param body → 200400401403500default
DELETE
/v1/user/team
Delete Team
delete-v1-user-team 1 param body → 200400403500default
GET
/v1/user/team/member
Get Team Members
get-v1-user-team-member 1 param → 200401403500default
POST
/v1/user/team/member
Add Team Member
post-v1-user-team-member 1 param body → 200400401403500default
DELETE
/v1/user/team/member
Delete Team Member
delete-v1-user-team-member 1 param body → 200400401403500default
PATCH
/v1/user/team/member
Update Team Member
patch-v1-user-team-member 1 param body → 200400401403500default
PATCH
/v1/user/team/member/accept
Update Team Member
patch-v1-user-team-member-accept body → 200400401403500default
GET
/v1/user/team/default-members
Get Default Team Members
get-v1-user-team-default-members 1 param → 200401403500default
POST
/v1/user/team/default-members
Set Default Team Members
post-v1-user-team-default-members 1 param body → 200400401403500default
DELETE
/v1/user/team/default-members
Delete Default Team Members
delete-v1-user-team-default-members 1 param body → 200400401403500default
POST
/v1/admin/team/member
Add Team Member (Admin)
post-v1-admin-team-member body → 200400401403500default
POST
/v1/payment/stripe/checkout_session
Create Subscription Checkout
post-v1-payment-stripe-checkout_session 1 param body → 200400401500default
GET
/v1/integration/{name}
Get Integration
get-v1-integration 2 params → 200400500default
POST
/v1/integration/{name}
Create Integration
post-v1-integration 2 params → 200400500default
PATCH
/v1/integration/{name}
Verify Integration
patch-v1-integration 2 params body → 200400500default
DELETE
/v1/integration/{name}
Delete Integration
delete-v1-integration 2 params body → 200400default
GET
/v1/integration/{name}/all
Get All Integrations
get-v1-integration-name-all 2 params → 200400500default
POST
/v1/template/contribute
Contribute to Public Templates
post-v1-template-contribute 1 param body → 200400500default
GET
/v1/integration/{name}/profile
Get Integration User Profile
get-v1-integration-name-profile 2 params → 200400500default
GET
/v1/template/leaderboard
Get Leaderboard
get-v1-template-leaderboard 9 params → 200400401500default
GET
/v1/payment/price_list
Get price list
get-v1-payment-price_list 1 param → 200400401500default
PATCH
/v1/admin/team
Admin API to update team details
patch-v1-admin-team 1 param body → 200400401404500default
POST
/v1/admin/usage
Set Usage Limit
post-v1-admin-usage body → 200400401404500default
GET
/v1/admin/usage
Get User API service Usage
get-v1-admin-usage body → 200400401404500default
GET
/v1/admin/automations
Get Automations List
get-v1-admin-automations 5 params → 200400401404500default
DELETE
/v1/admin/automations
Delete User Automation
delete-v1-admin-automations 3 params → 200400401404500default
PATCH
/v1/admin/automations
Update Automation (Admin)
update-v1-admin-automations 2 params body → 200400401404500default
POST
/v1/admin/automations/alert
Admin Automations alert
post-v1-admin-automations-alert body → 200400401500default
POST
/v1/admin/aurora_proxy
Proxy requests to Aurora service
post-v1-admin-aurora-proxy body → 200400401404500default
POST
/v1/admin/growth-plan/user-mapping
Create or update growth plan user mapping
post-v1-admin-growth-plan-user-mapping body → 200400401404500default
DELETE
/v1/admin/growth-plan/user-mapping
Delete growth plan user mapping
delete-v1-admin-growth-plan-user-mapping 1 param → 200400401404500default
GET
/v1/admin/growth-plan/user-mapping
Get growth plan user mapping for a specific email
get-v1-admin-growth-plan-user-mapping 1 param → 200400401404500default
GET
/v1/admin/stripe/prices
Get all Stripe prices for a product
get-v1-admin-stripe-prices 1 param → 200400401403500default
GET
/v1/admin/team/usage-stats
Get comprehensive team usage statistics
get-v1-admin-team-usage-stats 1 param → 200400401404500default
GET
/v1/admin/plan-limits
Get all plan default limits
get-v1-admin-plan-limits → 200401500default
PATCH
/v1/admin/plan-limits
Update plan default limits
patch-v1-admin-plan-limits body → 200400401404500default
PUT
/v1/admin/report/export/{export_id}/status
Update Export Status
put-v1-report-export-export_id-status 2 params body → 200400401404500default
POST
/v1/admin/report/{report_type}
Generate Report for Team (Admin)
post-v1-admin-report-report_type 1 param body → 200400401404500default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AutomationScanData (21 properties), TeamMemberItem (7 properties), IntegrationListItems (7 properties), AdminAutomationsItem (6 properties). Each schema is shown below with its type and property counts.

IntegrationListItems
object
7 properties 7 required
ServiceUsageItem
object
3 properties 3 required
UsageRangeEnum
string
TeamMemberItem
object
7 properties 3 required
StripePriceItem
object
6 properties 3 required
PlanDefaultLimit
object
5 properties 3 required
ContributorSummary
object
5 properties
WorkspaceItem
object
5 properties 5 required
PriceListItem
object
4 properties 4 required
EnumerationIds
object
1 property 1 required
AdminAutomationsItem
object
6 properties 6 required
AutomationScanData
object
21 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-internal-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

Nuclei
AE Profile APIs.io
Nuclei agents API
AE Profile APIs.io
Nuclei Asset API
AE Profile APIs.io
Nuclei assets API
AE Profile APIs.io
Nuclei automations API
AE Profile APIs.io
Nuclei billing API
AE Profile APIs.io
Nuclei chaos API
AE Profile APIs.io
Nuclei configurations API
AE Profile APIs.io
Nuclei deprecated API
AE Profile APIs.io
Nuclei domains API
AE Profile APIs.io
Nuclei elog API
AE Profile APIs.io
Nuclei enumeration API
AE Profile APIs.io
#internal
← Back to N APIs
API Details
ID
nuclei:nuclei-internal-api
Base URL
https://api.projectdiscovery.io
Docs
https://nuclei.projectdiscovery.io
Provider
Nuclei
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network