Skip to content

updating the api docs from latest openAPI specs #164

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ To build the final product, we have a couple of additional steps:

- Either download the latest `openapi.yaml` manually or run `./bin/download-api.sh`
- Run `./bin/generate-api.sh` to generate any new API files
- **OR** run `./bin/generate-filtered-api.sh` to generate API docs without internal/admin endpoints

3. Deployment

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/domains/export
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/domains/export
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/domains
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/domains
---
3 changes: 3 additions & 0 deletions api-reference/assets/add-labels-to-an-asset.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/asset/{asset_id}/labels
---
3 changes: 3 additions & 0 deletions api-reference/assets/delete-asset-by-filters.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/asset
---
3 changes: 3 additions & 0 deletions api-reference/assets/delete-labels-of-an-asset.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/asset/{asset_id}/labels
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/{asset_id}/changelogs
---
3 changes: 3 additions & 0 deletions api-reference/assets/get-asset-changelogs-for-all-assets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/changelogs
---
3 changes: 3 additions & 0 deletions api-reference/assets/modify-labels-of-an-asset.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/asset/{asset_id}/labels
---
3 changes: 3 additions & 0 deletions api-reference/assets/update-asset-labels.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/asset/labels
---
3 changes: 3 additions & 0 deletions api-reference/automations/create-automation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/automations
---
3 changes: 3 additions & 0 deletions api-reference/automations/delete-automation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/automations/{event}
---
3 changes: 3 additions & 0 deletions api-reference/automations/get-automation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/automations/{event}
---
3 changes: 3 additions & 0 deletions api-reference/automations/get-automations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/automations
---
3 changes: 3 additions & 0 deletions api-reference/automations/update-automation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/automations/{event}
---
3 changes: 3 additions & 0 deletions api-reference/billing/get-the-monthly-billing-cycle-dates.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/billing-cycles
---
3 changes: 3 additions & 0 deletions api-reference/bulk-update-user-template.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v2/template/user/upload
---
3 changes: 3 additions & 0 deletions api-reference/chaos/domain-&-organization-name-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/domain/search
---
3 changes: 3 additions & 0 deletions api-reference/chaos/get-organization-by-domain.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/organization/search
---
3 changes: 3 additions & 0 deletions api-reference/configurations/add-custom-severity-mapping.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/scans/config/severity
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/scans/config/exclude
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/scans/config/severity
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/scans/config/exclude
---
3 changes: 3 additions & 0 deletions api-reference/configurations/get-custom-severity-mappings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/config/severity
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/scans/config/{config_id}/severity
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/categories
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/categories
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/create-an-asset-group.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/asset/enumerate/group
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/delete-an-asset-group.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/asset/enumerate/group/{group_id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/domain/{domain_name}/export
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/get-domain-stats.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/domain/{domain_name}/stats
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/domain/{domain_name}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/domain/{domain_name}/filters
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/update-an-asset-group.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/asset/enumerate/group/{group_id}
---
3 changes: 3 additions & 0 deletions api-reference/full-text-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/vulnerability/search
---
3 changes: 3 additions & 0 deletions api-reference/get-a-list-of-invoices-for-a-customer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/payment/stripe/invoices
---
3 changes: 3 additions & 0 deletions api-reference/get-all-filters-for-vulnerabilities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/vulnerability/filters
---
3 changes: 3 additions & 0 deletions api-reference/get-asset-enumeration-history-data.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/history
---
3 changes: 3 additions & 0 deletions api-reference/get-error-statistics-of-given-scan-id.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/{scan_id}/error_stats
---
3 changes: 3 additions & 0 deletions api-reference/get-leaderboard-id-details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/template/leaderboard/{name}
---
3 changes: 3 additions & 0 deletions api-reference/get-vulnerability-by-id.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/vulnerability/{id}
---
3 changes: 3 additions & 0 deletions api-reference/history/get-scan-log-stats-of-given-scan-id.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vulns/history
---
3 changes: 0 additions & 3 deletions api-reference/internal/add-team-member-admin.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/add-team-member.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/contribute-to-public-templates.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/create-integration.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/create-new-user.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/create-subscription-checkout.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/create-team.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/delete-integration.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/delete-team-member.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/delete-team.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-all-integrations.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-integration-user-profile.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-integration.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-leaderboard.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-team-members.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-team.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/get-token-usage-admin.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/patch-user-profile.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/set-scan-token-for-user.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/update-team-member.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/update-team.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions api-reference/internal/verify-integration.mdx

This file was deleted.

3 changes: 3 additions & 0 deletions api-reference/leaks/your-get-endpoint-for-domain-stats.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/leaks/stats/domain
---
3 changes: 3 additions & 0 deletions api-reference/leaks/your-get-endpoint-for-email-stats.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/leaks/stats/email
---
3 changes: 3 additions & 0 deletions api-reference/oauth/exchange-code-for-access-token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/integration/oauth/{name}/exchange-token
---
3 changes: 3 additions & 0 deletions api-reference/oauth/get-oauth-status.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/integration/oauth/{name}/status
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/integration/oauth/{name}/generate-url
---
3 changes: 3 additions & 0 deletions api-reference/oauth/revoke-oauth-token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/integration/oauth/{name}/revoke
---
3 changes: 3 additions & 0 deletions api-reference/rename-tunnel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/user/tunnels
---
3 changes: 3 additions & 0 deletions api-reference/results/get-all-vulnerability-changelogs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vuln/changelogs
---
3 changes: 3 additions & 0 deletions api-reference/results/get-vulnerability-changelogs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vuln/{vuln_id}/changelogs
---
3 changes: 3 additions & 0 deletions api-reference/scan/get-remediation-efficiency-stats.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/remediation-efficiency
---
3 changes: 3 additions & 0 deletions api-reference/scan/get-scan-vuln-exposure-metrics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vulns/exposures/metrics
---
3 changes: 3 additions & 0 deletions api-reference/scan/get-scan-vuln-regression-metrics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vulns/regression/metrics
---
3 changes: 3 additions & 0 deletions api-reference/scan/get-scan-vuln-remediation-metrics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/scans/vulns/remediation/metrics
---
Loading
Loading