Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Brand updates #115

Merged
merged 19 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: "Cloud API Reference Introduction"
description: 'Details on the ProjectDiscovery Cloud Platform API'
description: 'Details on the ProjectDiscovery API'
sidebarTitle: 'Introduction'
---

## Overview

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/).
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/).

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.

## Authentication

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.
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.

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.
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.

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.

## Resources
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery Cloud Platform API.
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery API.

<CardGroup cols={2}>
<Card
Expand Down
6 changes: 3 additions & 3 deletions cloud/admin.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ProjectDiscovery Cloud Platform Settings & Administration "
title: "Settings & Administration "
description: "Review administrative, team, and account settings"
sidebarTitle: "System Settings"
---

## Summary

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.
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.

If you have questions about settings that are not covered here, or functionality that you think would be helpful - [get in touch.](/help)

Expand Down Expand Up @@ -39,7 +39,7 @@ To modify team settings select a team from the global navigation to display thos

### User Types

ProjectDiscovery Cloud Platform supports four types of users with the following permissions:
ProjectDiscovery supports four types of users with the following permissions:

- Owner: Read, write, invite, billing
- Admin: Read, write, invite
Expand Down
4 changes: 2 additions & 2 deletions cloud/assets/adding-assets.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Adding Assets"
description: "Learn how to add and manage assets in ProjectDiscovery Cloud Platform"
description: "Learn how to add and manage assets in ProjectDiscovery"
sidebarTitle: "Adding Assets"
---

## Overview

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:
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:

<CardGroup cols={3}>
<Card
Expand Down
2 changes: 1 addition & 1 deletion cloud/editor/ai.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AI Assistance"
description: "Review details on using AI to help generate templates for Nuclei and PDCP"
description: "Review details on using AI to help generate templates for Nuclei and ProjectDiscovery"
---

<img src="/images/ai.jpg" alt="AI Prompt" width="800px" />
Expand Down
8 changes: 4 additions & 4 deletions cloud/editor/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ sidebarTitle: "Overview"
---
<Tip>For more in-depth information about Nuclei templates, including details on template structure and supported protocols [check out](/templates/introduction).</Tip>

[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.
[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.

![Templates Editor](/images/editor.jpg)


## Template Compatibility

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.
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.

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).
## Features
Expand All @@ -30,7 +30,7 @@ Current and upcoming features:
| **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 \* |
| **Scan (LIST, CIDR, ASN)** | In the professional version, run scans on target lists, network ranges (CIDR), AS numbers (ASN). | Teams |
| **REST API** | In the professional version, fetch templates, call the AI, and perform scans remotely using APIs. | Teams |
| **PDCP Sync** | Sync your generated templates with the ProjectDiscovery Cloud Platform for easy access and management, available in the professional version. | Teams |
| **PDCP Sync** | Sync your generated templates with our cloud platform for easy access and management, available in the professional version. | Teams |

## Free Feature Limitations

Expand All @@ -43,7 +43,7 @@ The limitations, reset daily, ensure system integrity and availability while pro

## How to Get Started

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:
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:

1. Log in to your account at [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io).
2. Click on the "**Create new template**" button to open up a fresh editor.
Expand Down
16 changes: 8 additions & 8 deletions cloud/editor/recommended.mdx
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
---
title: "Recommended"
description: "Learn more about using Recommended Templates in PDCP (Teams)"
description: "Learn more about using recommended templates with ProjectDiscovery"
---

<Info>
The functionality described on this page is **only** available through
[ProjectDiscovery Cloud Platform Teams](https://projectdiscovery.io/pricing).
The functionality described on this page is **only** available on
[ProjectDiscovery team account](https://projectdiscovery.io/pricing).
</Info>

## Overview

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.
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.

**Recommended templates are a curated subset of the full template library designed for efficiently scanning your attack surface.**

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.

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.
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.

Rather than a list, PDCP's Recommended templates are curated through defined filters.
Rather than a list, recommended templates are curated through defined filters.

_This approach ensures that the curated list remains up-to-date as new templates are added._

Filtering for Recommended templates includes:
Filtering for recommended templates includes:

- All template severities except info

- Type: http, tcp, or javascript

- Exclusion of the tags: tech, dos, fuzz, creds-stuffing, token-spray, osint

- Exclusion of specific templates the list is available for review here --> [Recommended Templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)
- Exclusion of specific templates the list is available for review here --> [recommended templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)

<Note>
If you have questions, reach out to us through support@projectdiscovery.io.
Expand Down
49 changes: 19 additions & 30 deletions cloud/general-faq.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,8 @@
---
title: "PDCP FAQ"
description: "Frequently Asked Questions about ProjectDiscovery Cloud Platform"
title: "Frequently Asked Questions"
sidebarTitle: "FAQ"
---

<Tip>
Sign up for [ProjectDiscovery Cloud
Platform](https://cloud.projectdiscovery.io/)
</Tip>

## Summary

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.

### Other FAQs

Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.

- [Assets FAQ](cloud/assets/overview#faq)
- [Scanning FAQ](/cloud/scanning/overview#faq)
- [Nuclei Templates FAQ](/cloud/editor/faq)

Questions about the product that you don't see covered here - we want to know!
Contact support@projectdiscovery.io with any recommendations or issues.

## General

Expand All @@ -36,7 +16,7 @@ You can find our [terms of use](https://projectdiscovery.io/terms) here.

<Accordion title="Are there use cases that are prohibited?">

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.
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.

If you have questions, don't hesitate to reach out - support@projectdiscovery.io!

Expand All @@ -46,15 +26,13 @@ _Note: Unauthorized scans that lead to abuse reports will result in account susp

<Accordion title="What browsers are supported?">

ProjectDiscovery Cloud Platform works best on chromium-based browsers.
ProjectDiscovery works best on chromium-based browsers.

</Accordion>

<Accordion title="How do I get support?">

For questions about ProjectDiscovery Cloud Platform first we recommend exploring our Documentation. Trigger our AI-based search with a question or phrase.

If you can't find what you need here - [email us](mailto:support@projectdiscovery.io), we're here to help!
If you can't find what you need in our documentation - [email us](mailto:support@projectdiscovery.io), we're here to help!

</Accordion>

Expand All @@ -72,16 +50,16 @@ This also applies to any information entered into our [AI template editor](/clou

</Accordion>

<Accordion title="Where does ProjectDiscovery Cloud Platform data reside?">
<Accordion title="Where does ProjectDiscovery data reside?">

ProjectDiscovery Cloud Platform data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
ProjectDiscovery data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
We are SOC 2 compliant and our latest security reports can be requested from our Trust Center at security.projectdiscovery.io.

</Accordion>

<Accordion title="Can I self-host ProjectDiscovery Cloud Platform?">
<Accordion title="Can I self-host ProjectDiscovery?">

We are working on an on-prem version of our Cloud Platform. Get in touch with us at sales@projectdiscovery.io to share more about your requirements and learn about our product roadmap for upcoming features.
We are working on an on-prem version of our cloud platform. Get in touch with us at [sales@projectdiscovery.io](mailto:sales@projectdiscovery.io) to share more about your requirements and learn about our product roadmap for upcoming features.

</Accordion>

Expand Down Expand Up @@ -133,3 +111,14 @@ For existing users, visit **Settings –> Billing** to set up your subscription.
Our primary payment method is via credit card invoiced in USD. For ACH payments or other custom payment requirements, please reach out to [sales@projectdiscovery.io](mailto:sales@projectdiscovery.io).
</Accordion>
</AccordionGroup>

## Other FAQs

Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.

- [Assets FAQ](/cloud/assets/overview)
- [Scanning FAQ](/cloud/scanning/overview)
- [Nuclei Templates FAQ](/cloud/editor/faq)

Questions about the product that you don't see covered here - we want to know!
Contact support@projectdiscovery.io with any recommendations or issues.
Loading
Loading