Skip to content
Closed
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 0 additions & 6 deletions .codemapignore

This file was deleted.

21 changes: 21 additions & 0 deletions mintlify-docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Mintlify

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 7 additions & 0 deletions mintlify-docs/api-reference/Authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Authentication"
---

The API supports authentication with an API token with the "Web API" permission, without limited scopes of access.

You can provision an API token [from the Settings page](https://semgrep.dev/orgs/-/settings/tokens).
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/DeploymentsService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Deployment"
description: "Deployments encapsulate your organization's security organization, with multiple projects, policies, and integrations. As the root object of the organization, they're similarly the root object of the API."
---
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/FindingsService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Code, Supply Chain, and AI-Powered Scan"
description: "Manage and retrieve code, supply chain, and AI-powered scan findings from Semgrep scans"
---
18 changes: 18 additions & 0 deletions mintlify-docs/api-reference/Introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Introduction"
description: "Welcome to Semgrep's portal for the Semgrep AppSec Platform web API."
---

Semgrep is a fast, open-source, static analysis tool for finding bugs and enforcing code standards at editor, commit, and CI time. [Get started.](https://semgrep.dev/getting-started/)

Semgrep analyzes code locally on your computer or in your build environment: **code is never uploaded.**

This API is documented in the **OpenAPI format**.


Download OpenAPI specification:

<CardGroup cols="3">
<Card title="Download" href="https://semgrep.dev/api/v1/public_v1.openapi.yaml" icon="download" horizontal/>
</CardGroup>

4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/MiscService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Other"
description: "Utility endpoints."
---
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/PoliciesService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Policies"
description: "View and manage the Policies of your organization."
---
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/ScansService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Scans"
description: "View details of scans associated with projects in your organization."
---
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/SecretsService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Secrets"
description: "View and manage the Secrets of your organization."
---
6 changes: 6 additions & 0 deletions mintlify-docs/api-reference/SupplyChainService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Supply Chain"
description: "Manage the Supply Chain findings and dependencies of your organization."
---

A request body is required, but may be an empty object.
5 changes: 5 additions & 0 deletions mintlify-docs/api-reference/Terms-of-Use.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Terms of Use"
---

Please note, the materials made available herein are subject to the [Semgrep Terms of Use](https://semgrep.dev/resources/website-terms/), and your access or use of any of the same is your acknowledgment and acceptance of the such terms.
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/TicketingService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Ticketing"
description: "Create and manage external tickets"
---
4 changes: 4 additions & 0 deletions mintlify-docs/api-reference/TriageService.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Triage"
description: "View and manage the triage of your organization."
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "List deployments"
openapi: get /api/v1/deployments
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "List code, supply chain, or AI-powered scan findings"
openapi: get /api/v1/deployments/{deploymentSlug}/findings
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/bootstrap-sms-vpc
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/miscservice/ping.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/ping
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/policiesservice/list-policies.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentId}/policies
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentId}/policies/{policyId}
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/policiesservice/update-policy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /api/v1/deployments/{deploymentId}/policies/{policyId}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /api/v1/deployments/{deploymentSlug}/projects/{projectName}/tags
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /api/v1/deployments/{deploymentSlug}/projects/{projectName}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentSlug}/projects/{projectName}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentSlug}/projects
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /api/v1/deployments/{deploymentSlug}/projects/{projectName}/tags
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /api/v1/deployments/{deploymentSlug}/projects/{projectName}/managed-scan
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /api/v1/deployments/{deploymentSlug}/projects/{projectName}
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/scansservice/get-scan-details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentId}/scan/{scanId}
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/scansservice/list-scans-beta.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentId}/scans/search
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/secretsservice/list-secrets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentId}/secrets
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentId}/sbom/export
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /api/v1/deployments/{deploymentId}/sbom/export/{taskToken}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentId}/dependencies
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentId}/dependencies/repositories/{repositoryId}/lockfiles
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentId}/dependencies/repositories
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentSlug}/tickets
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /api/v1/deployments/{deploymentId}/ticketing/v2/tickets/{externalTicketId}
---
3 changes: 3 additions & 0 deletions mintlify-docs/api-reference/triageservice/bulk-triage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /api/v1/deployments/{deploymentSlug}/triage
---
13 changes: 13 additions & 0 deletions mintlify-docs/category/bitbucket-pr-comments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Bitbucket PR comments"
---

<CardGroup>
<Card title="Bitbucket Cloud" icon="file-text" href="/semgrep-appsec-platform/bitbucket-cloud-pr-comments">
Enable PR comments in your Bitbucket Cloud repositories to display Semgrep findings to developers.
</Card>

<Card title="Bitbucket Data Center" icon="file-text" href="/semgrep-appsec-platform/bitbucket-data-center-pr-comments">
Enable PR comments in your Bitbucket Data Center repositories to display Semgrep findings to developers.
</Card>
</CardGroup>
21 changes: 21 additions & 0 deletions mintlify-docs/category/ci-references-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "CI references"
---

<CardGroup>
<Card title="CI environment variables" icon="file-text" href="/semgrep-ci/ci-environment-variables-1">
Configure Semgrep in CI by setting various environment variables. Enable diff-aware scanning, connect to Semgrep AppSec Platform, and more.
</Card>

<Card title="Sample CI configurations" icon="file-text" href="/semgrep-ci/sample-ci-configs-1">
View sample configuration files to run Semgrep with various CI/CD providers such as GitHub, GitLab, Jenkins, Buildkite, CircleCI, and more.
</Card>

<Card title="Findings in CI" icon="file-text" href="/semgrep-ci/findings-ci-1">
Learn how Semgrep Pro tracks findings and triage states in CI pipelines.
</Card>

<Card title="Packages in Semgrep docker" icon="file-text" href="/semgrep-ci/packages-in-semgrep-docker-1">
Packages included in the latest Semgrep docker image.
</Card>
</CardGroup>
21 changes: 21 additions & 0 deletions mintlify-docs/category/ci-references.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "CI references"
---

<CardGroup>
<Card title="CI environment variables" icon="file-text" href="/semgrep-ci/ci-environment-variables">
Configure Semgrep in CI by setting various environment variables. Enable diff-aware scanning, connect to Semgrep AppSec Platform, and more.
</Card>

<Card title="Sample CI configurations" icon="file-text" href="/semgrep-ci/sample-ci-configs">
View sample configuration files to run Semgrep with various CI/CD providers such as GitHub, GitLab, Jenkins, Buildkite, CircleCI, and more.
</Card>

<Card title="Findings in CI" icon="file-text" href="/semgrep-ci/findings-ci">
Learn how Semgrep Pro tracks findings and triage states in CI pipelines.
</Card>

<Card title="Packages in Semgrep docker" icon="file-text" href="/semgrep-ci/packages-in-semgrep-docker">
Packages included in the latest Semgrep docker image.
</Card>
</CardGroup>
21 changes: 21 additions & 0 deletions mintlify-docs/category/deployment-at-scale.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Deployment at scale"
---

<CardGroup>
<Card title="Teams and users" icon="folder" href="/deployment/teams/overview">
1 item
</Card>

<Card title="Tokens" icon="file-text" href="/deployment/tokens">
Manage tokens used to authorize requests to Semgrep AppSec Platform and API.
</Card>

<Card title="Tag projects" icon="file-text" href="/semgrep-appsec-platform/tags">
Guidelines on how to add or remove tags through Semgrep AppSec Platform and semgrepconfig.yml file.
</Card>

<Card title="Semgrep Network Broker" icon="file-text" href="/semgrep-ci/network-broker">
Learn how to set up the Semgrep Network Broker, which facilitates secure access between Semgrep and your private network.
</Card>
</CardGroup>
12 changes: 12 additions & 0 deletions mintlify-docs/category/glossaries-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Glossaries"
---

<CardGroup>
<Card title="Code glossary" icon="file-text" href="/semgrep-code/glossary">
Definitions of Semgrep Code product-specific terms.
</Card>
<Card title="Supply Chain glossary" icon="file-text" href="/semgrep-supply-chain/glossary">
Definitions of Semgrep Supply Chain and software composition analysis (SCA) terms.
</Card>
</CardGroup>
13 changes: 13 additions & 0 deletions mintlify-docs/category/glossaries.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Glossaries"
---

<CardGroup>
<Card title="Code glossary" icon="file-text" href="/semgrep-code/glossary">
Definitions of Semgrep Code product-specific terms.
</Card>

<Card title="Supply Chain glossary" icon="file-text" href="/semgrep-supply-chain/glossary">
Definitions of Semgrep Supply Chain and software composition analysis (SCA) terms.
</Card>
</CardGroup>
15 changes: 15 additions & 0 deletions mintlify-docs/category/go.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Go"
description: "Security guides and cheatsheets for the Go programming language and related frameworks."
---


<CardGroup>
<Card title="Command Injection in Go" icon="file-text" href="/cheat-sheets/go-command-injection">
Cheat sheet for the prevention of Command Injection vulnerabilities for Go.
</Card>

<Card title="XSS in Go" icon="file-text" href="/cheat-sheets/go-xss">
Cheat sheet for the prevention of Cross-site Scripting (XSS) vulnerabilities for Go and net/http.
</Card>
</CardGroup>
22 changes: 22 additions & 0 deletions mintlify-docs/category/java.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Java"
description: "Security guides and cheatsheets for the Java programming language and related frameworks."
---

<CardGroup>
<Card title="Code Injection in Java" icon="file-text" href="/cheat-sheets/java-code-injection">
Cheat sheet for the prevention of Code Injection vulnerabilities for Java.
</Card>

<Card title="Command Injection in Java" icon="file-text" href="/cheat-sheets/java-command-injection">
Cheat sheet for the prevention of Command Injection vulnerabilities for Java.
</Card>

<Card title="XSS in Java + JSP" icon="file-text" href="/cheat-sheets/java-jsp-xss">
Cheat sheet for the prevention of Cross-site Scripting (XSS) vulnerabilities for Java and Java Server Pages (JSP).
</Card>

<Card title="XEE in Java" icon="file-text" href="/cheat-sheets/java-xxe">
Cheat sheet for the prevention of XML External Entity (XEE) vulnerabilities for Java.
</Card>
</CardGroup>
Loading
Loading