You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/introduction.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,25 @@
1
1
---
2
2
title: "Cloud API Reference Introduction"
3
-
description: 'Details on the ProjectDiscovery Cloud Platform API'
3
+
description: 'Details on the ProjectDiscovery API'
4
4
sidebarTitle: 'Introduction'
5
5
---
6
6
7
7
## Overview
8
8
9
-
The ProjectDiscovery Cloud Platform API v1 is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has resource-oriented URLs, accepts and returns JSON in most cases, and the API uses standard HTTP response codes, authentication, and verbs. Our API also conforms to the [OpenAPI Specification](https://www.openapis.org/).
9
+
The ProjectDiscovery API v1 is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has resource-oriented URLs, accepts and returns JSON in most cases, and the API uses standard HTTP response codes, authentication, and verbs. Our API also conforms to the [OpenAPI Specification](https://www.openapis.org/).
10
10
11
11
This API documentation will walk you through each of the available resources, and provides code examples for `cURL`, `Python`, `JavaScript`, `PHP`, `Go` and `Java`. Each endpoint includes the required authorization information and parameters, and provides examples of the response you should expect.
12
12
13
13
## Authentication
14
14
15
-
The ProjectDiscovery Cloud Platform API uses API keys to authenticate requests. You can view and manage your API key in ProjectDiscovery Cloud Platform at https://cloud.projectdiscovery.io/ under your user information.
15
+
The ProjectDiscovery API uses API keys to authenticate requests. You can view and manage your API key in ProjectDiscovery at https://cloud.projectdiscovery.io/ under your user information.
16
16
17
-
Authentication with the API is performed using a custom request header - `X-Api-Key` - which should simply be the value of your API key found with your ProjectDiscovery Cloud Platform account.
17
+
Authentication with the API is performed using a custom request header - `X-Api-Key` - which should simply be the value of your API key found with your ProjectDiscovery account.
18
18
19
19
You must make all API calls over `HTTPS`. Calls made over plain HTTP will fail, as will requests without authentication or without all required parameters.
20
20
21
21
## Resources
22
-
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery Cloud Platform API.
22
+
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery API.
description: "Review administrative, team, and account settings"
4
4
sidebarTitle: "System Settings"
5
5
---
6
6
7
7
## Summary
8
8
9
-
This guide covers general account administration under settings in the ProjectDiscovery Cloud Platform (PDCP). These administrative and system settings include details about your account, team settings for administrators, and password/2FA.
9
+
This guide covers general account administration under settings in our cloud platform. These administrative and system settings include details about your account, team settings for administrators, and password/2FA.
10
10
11
11
If you have questions about settings that are not covered here, or functionality that you think would be helpful - [get in touch.](/help)
12
12
@@ -39,7 +39,7 @@ To modify team settings select a team from the global navigation to display thos
39
39
40
40
### User Types
41
41
42
-
ProjectDiscovery Cloud Platform supports four types of users with the following permissions:
42
+
ProjectDiscovery supports four types of users with the following permissions:
Copy file name to clipboardExpand all lines: cloud/assets/adding-assets.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
title: "Adding Assets"
3
-
description: "Learn how to add and manage assets in ProjectDiscovery Cloud Platform"
3
+
description: "Learn how to add and manage assets in ProjectDiscovery"
4
4
sidebarTitle: "Adding Assets"
5
5
---
6
6
7
7
## Overview
8
8
9
-
Assets in ProjectDiscovery Cloud Platform can be any hosts you want to monitor - URLs, IP addresses, or CIDR ranges. There are three primary methods to add assets:
9
+
Assets in our cloud platform can be any hosts you want to monitor - URLs, IP addresses, or CIDR ranges. There are three primary methods to add assets:
Copy file name to clipboardExpand all lines: cloud/editor/overview.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,14 @@ sidebarTitle: "Overview"
5
5
---
6
6
<Tip>For more in-depth information about Nuclei templates, including details on template structure and supported protocols [check out](/templates/introduction).</Tip>
7
7
8
-
[The Template Editor](https://cloud.projectdiscovery.io) is a multi-functional cloud-hosted tool designed for creating, running, and sharing templates (Nuclei and ProjectDiscovery Cloud Platform). It's packed with helpful features for individual and professional users seeking to manage and execute templates.
8
+
[The Template Editor](https://cloud.projectdiscovery.io/public/public-template) is a multi-functional cloud-hosted tool designed for creating, running, and sharing templates (Nuclei and ProjectDiscovery). It's packed with helpful features for individual and professional users seeking to manage and execute templates.
9
9
10
10

11
11
12
12
13
13
## Template Compatibility
14
14
15
-
In addition to the Template Editor, ProjectDiscovery Cloud Platform(PDCP) supports any templates compatible with [Nuclei](nuclei/overview). These templates are exactly the same powerful YAML format supported in open source.
15
+
In addition to the Template Editor, our cloud platform supports any templates compatible with [Nuclei](nuclei/overview). These templates are exactly the same powerful YAML format supported in open source.
16
16
17
17
Take a look at our [Templates](/Templates/introduction) documentation for a wealth of resources available around template design, structure, and how they can be customized to meet an enormous range of use cases. As always, if you have questions [we're here to help](/help/home).
18
18
## Features
@@ -30,7 +30,7 @@ Current and upcoming features:
30
30
|**AI Assistance**| Employ AI to craft Nuclei Templates based on the context of specified vulnerabilities. This feature simplifies template creation and tailors them to minimize the time required for creation. | Free \*|
31
31
|**Scan (LIST, CIDR, ASN)**| In the professional version, run scans on target lists, network ranges (CIDR), AS numbers (ASN). | Teams |
32
32
|**REST API**| In the professional version, fetch templates, call the AI, and perform scans remotely using APIs. | Teams |
33
-
|**PDCP Sync**| Sync your generated templates with the ProjectDiscovery Cloud Platform for easy access and management, available in the professional version. | Teams |
33
+
|**PDCP Sync**| Sync your generated templates with our cloud platform for easy access and management, available in the professional version. | Teams |
34
34
35
35
## Free Feature Limitations
36
36
@@ -43,7 +43,7 @@ The limitations, reset daily, ensure system integrity and availability while pro
43
43
44
44
## How to Get Started
45
45
46
-
Begin by ensuring you have an account. If not, sign up on [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io/) and follow the steps below:
46
+
Begin by ensuring you have an account. If not, sign up on [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io/sign-up) and follow the steps below:
47
47
48
48
1. Log in to your account at [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io).
49
49
2. Click on the "**Create new template**" button to open up a fresh editor.
The functionality described on this page is **only** available on
8
+
[ProjectDiscovery team account](https://projectdiscovery.io/pricing).
9
9
</Info>
10
10
11
11
## Overview
12
12
13
-
When setting up a scan in ProjectDiscovery Cloud Platform (PDCP) you have the option to build your scan using custom templates, [all templates](https://github.com/projectdiscovery/nuclei-templates), or recommended templates.
13
+
When setting up a scan in our cloud platform you have the option to build your scan using custom templates, [all templates](https://github.com/projectdiscovery/nuclei-templates), or recommended templates.
14
14
15
15
**Recommended templates are a curated subset of the full template library designed for efficiently scanning your attack surface.**
16
16
17
17
This subset of templates, nearly 4000 in total, focuses on relevant and exploitable vulnerabilities, excluding informational templates and templates with the potential to generate false positives.
18
18
19
-
The curated set of Recommended templates is available as a config file and can be viewed in the Nuclei repository - [Recommended Templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml), or withing the application.
19
+
The curated set of recommended templates is available as a config file and can be viewed in the Nuclei repository - [recommended templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml), or withing the application.
20
20
21
-
Rather than a list, PDCP's Recommended templates are curated through defined filters.
21
+
Rather than a list, recommended templates are curated through defined filters.
22
22
23
23
_This approach ensures that the curated list remains up-to-date as new templates are added._
24
24
25
-
Filtering for Recommended templates includes:
25
+
Filtering for recommended templates includes:
26
26
27
27
- All template severities except info
28
28
29
29
- Type: http, tcp, or javascript
30
30
31
31
- Exclusion of the tags: tech, dos, fuzz, creds-stuffing, token-spray, osint
32
32
33
-
- Exclusion of specific templates the list is available for review here --> [Recommended Templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)
33
+
- Exclusion of specific templates the list is available for review here --> [recommended templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)
Copy file name to clipboardExpand all lines: cloud/general-faq.mdx
+19-30Lines changed: 19 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,8 @@
1
1
---
2
-
title: "PDCP FAQ"
3
-
description: "Frequently Asked Questions about ProjectDiscovery Cloud Platform"
2
+
title: "Frequently Asked Questions"
4
3
sidebarTitle: "FAQ"
5
4
---
6
5
7
-
<Tip>
8
-
Sign up for [ProjectDiscovery Cloud
9
-
Platform](https://cloud.projectdiscovery.io/)
10
-
</Tip>
11
-
12
-
## Summary
13
-
14
-
Check out the Frequently Asked Questions on this page to learn about general usage for ProjectDiscovery Cloud Platform (PDCP). We cover topics around data, system settings and administration, and pricing info.
15
-
16
-
### Other FAQs
17
-
18
-
Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.
19
-
20
-
-[Assets FAQ](cloud/assets/overview#faq)
21
-
-[Scanning FAQ](/cloud/scanning/overview#faq)
22
-
-[Nuclei Templates FAQ](/cloud/editor/faq)
23
-
24
-
Questions about the product that you don't see covered here - we want to know!
@@ -36,7 +16,7 @@ You can find our [terms of use](https://projectdiscovery.io/terms) here.
36
16
37
17
<Accordiontitle="Are there use cases that are prohibited?">
38
18
39
-
Our Cloud Platform is engineered for security and DevOps teams. Please include scan headers, whitelist your scan activities with your IT team, and limit scanning to authorized assets.
19
+
ProjectDiscovery is engineered for security and DevOps teams. Please include scan headers, whitelist your scan activities with your IT team, and limit scanning to authorized assets.
40
20
41
21
If you have questions, don't hesitate to reach out - [email protected]!
42
22
@@ -46,15 +26,13 @@ _Note: Unauthorized scans that lead to abuse reports will result in account susp
46
26
47
27
<Accordiontitle="What browsers are supported?">
48
28
49
-
ProjectDiscovery Cloud Platform works best on chromium-based browsers.
29
+
ProjectDiscovery works best on chromium-based browsers.
50
30
51
31
</Accordion>
52
32
53
33
<Accordiontitle="How do I get support?">
54
34
55
-
For questions about ProjectDiscovery Cloud Platform first we recommend exploring our Documentation. Trigger our AI-based search with a question or phrase.
56
-
57
-
If you can't find what you need here - [email us](mailto:[email protected]), we're here to help!
35
+
If you can't find what you need in our documentation - [email us](mailto:[email protected]), we're here to help!
58
36
59
37
</Accordion>
60
38
@@ -72,16 +50,16 @@ This also applies to any information entered into our [AI template editor](/clou
72
50
73
51
</Accordion>
74
52
75
-
<Accordiontitle="Where does ProjectDiscovery Cloud Platform data reside?">
53
+
<Accordiontitle="Where does ProjectDiscovery data reside?">
76
54
77
-
ProjectDiscovery Cloud Platform data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
55
+
ProjectDiscovery data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
78
56
We are SOC 2 compliant and our latest security reports can be requested from our Trust Center at security.projectdiscovery.io.
79
57
80
58
</Accordion>
81
59
82
-
<Accordiontitle="Can I self-host ProjectDiscovery Cloud Platform?">
60
+
<Accordiontitle="Can I self-host ProjectDiscovery?">
83
61
84
-
We are working on an on-prem version of our Cloud Platform. Get in touch with us at [email protected] to share more about your requirements and learn about our product roadmap for upcoming features.
62
+
We are working on an on-prem version of our cloud platform. Get in touch with us at [[email protected]](mailto:[email protected]) to share more about your requirements and learn about our product roadmap for upcoming features.
85
63
86
64
</Accordion>
87
65
@@ -133,3 +111,14 @@ For existing users, visit **Settings –> Billing** to set up your subscription.
133
111
Our primary payment method is via credit card invoiced in USD. For ACH payments or other custom payment requirements, please reach out to [[email protected]](mailto:[email protected]).
134
112
</Accordion>
135
113
</AccordionGroup>
114
+
115
+
## Other FAQs
116
+
117
+
Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.
118
+
119
+
-[Assets FAQ](/cloud/assets/overview)
120
+
-[Scanning FAQ](/cloud/scanning/overview)
121
+
-[Nuclei Templates FAQ](/cloud/editor/faq)
122
+
123
+
Questions about the product that you don't see covered here - we want to know!
0 commit comments