Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

hide all endpoints from secret scanning

Matheus Nogueira46ae701e67b7
diff --git a/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-endpoints.ts b/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-endpoints.ts
index 099bf649c8..3e2e941513 100644
--- a/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-endpoints.ts
+++ b/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-endpoints.ts
@@ -57,7 +57,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `list${sourceTypeId}DataSources`,
tags: [ApiDocsTags.SecretScanning],
description: `List the ${sourceType} Data Sources for the specified project.`,
@@ -107,7 +107,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `get${sourceTypeId}DataSource`,
tags: [ApiDocsTags.SecretScanning],
description: `Get the specified ${sourceType} Data Source by ID.`,
@@ -150,7 +150,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `get${sourceTypeId}DataSourceByName`,
tags: [ApiDocsTags.SecretScanning],
description: `Get the specified ${sourceType} Data Source by name and project ID.`,
@@ -205,7 +205,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `create${sourceTypeId}DataSource`,
tags: [ApiDocsTags.SecretScanning],
description: `Create ${
@@ -260,7 +260,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `update${sourceTypeId}DataSource`,
tags: [ApiDocsTags.SecretScanning],
description: `Update the specified ${sourceType} Data Source.`,
@@ -305,7 +305,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `delete${sourceTypeId}DataSource`,
tags: [ApiDocsTags.SecretScanning],
description: `Delete the specified ${sourceType} Data Source.`,
@@ -348,7 +348,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `trigger${sourceTypeId}DataSourceScan`,
tags: [ApiDocsTags.SecretScanning],
description: `Trigger a scan for the specified ${sourceType} Data Source.`,
@@ -391,7 +391,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `trigger${sourceTypeId}DataSourceResourceScan`,
tags: [ApiDocsTags.SecretScanning],
description: `Trigger a scan for the specified ${sourceType} Data Source resource.`,
@@ -436,7 +436,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `list${sourceTypeId}DataSourceResources`,
tags: [ApiDocsTags.SecretScanning],
description: `Get the resources associated with the specified ${sourceType} Data Source by ID.`,
@@ -481,7 +481,7 @@ export const registerSecretScanningEndpoints = <
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: `list${sourceTypeId}DataSourceScans`,
tags: [ApiDocsTags.SecretScanning],
description: `Get the scans associated with the specified ${sourceType} Data Source by ID.`,
diff --git a/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-router.ts b/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-router.ts
index dedfc9a02e..a880131773 100644
--- a/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-router.ts
+++ b/backend/src/ee/routes/v2/secret-scanning-v2-routers/secret-scanning-v2-router.ts
@@ -39,7 +39,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "listSecretScanningDataSourceOptions",
tags: [ApiDocsTags.SecretScanning],
description: "List the available Secret Scanning Data Source Options.",
@@ -63,7 +63,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "listSecretScanningDataSources",
tags: [ApiDocsTags.SecretScanning],
description: "List all the Secret Scanning Data Sources for the specified project.",
@@ -109,7 +109,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "listSecretScanningFindings",
tags: [ApiDocsTags.SecretScanning],
description: "List all the Secret Scanning Findings for the specified project.",
@@ -155,7 +155,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "updateSecretScanningFinding",
tags: [ApiDocsTags.SecretScanning],
description: "Update the specified Secret Scanning Finding.",
@@ -217,7 +217,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "updateSecretScanningFindingsBatch",
tags: [ApiDocsTags.SecretScanning],
description: "Update one or more Secret Scanning Findings in a batch.",
@@ -268,7 +268,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: readLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "getSecretScanningConfig",
tags: [ApiDocsTags.SecretScanning],
description: "Get the Secret Scanning Config for the specified project.",
@@ -313,7 +313,7 @@ export const registerSecretScanningV2Router = async (server: FastifyZodProvider)
rateLimit: writeLimit
},
schema: {
- hide: false,
+ hide: true,
operationId: "updateSecretScanningConfig",
tags: [ApiDocsTags.SecretScanning],
description: "Update the specified Secret Scanning Configuration.",
diff --git a/docs/api-reference/endpoints/secret-scanning/config/get-by-project-id.mdx b/docs/api-reference/endpoints/secret-scanning/config/get-by-project-id.mdx
deleted file mode 100644
index 4f1994d358..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/config/get-by-project-id.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by project ID"
-openapi: "GET /api/v2/secret-scanning/configs"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/config/update.mdx b/docs/api-reference/endpoints/secret-scanning/config/update.mdx
deleted file mode 100644
index bf068a20fc..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/config/update.mdx
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: "Update"
-openapi: "PATCH /api/v2/secret-scanning/configs"
----
-
-<Note>
- Check out the [Configuration Docs](/documentation/platform/secret-scanning/overview#configuration) for an in-depth guide on custom configurations.
-</Note>
\ No newline at end of file
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/create.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/create.mdx
deleted file mode 100644
index eeee8e019b..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/create.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Create"
-openapi: "POST /api/v2/secret-scanning/data-sources/bitbucket"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/delete.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/delete.mdx
deleted file mode 100644
index b2bb37d0f4..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/delete.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Delete"
-openapi: "DELETE /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-id.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-id.mdx
deleted file mode 100644
index 009d57dcb8..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-id.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by ID"
-openapi: "GET /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-name.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-name.mdx
deleted file mode 100644
index 5bf091ddb2..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-name.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by name"
-openapi: "GET /api/v2/secret-scanning/data-sources/bitbucket/data-source-name/{sourceName}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-resources.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-resources.mdx
deleted file mode 100644
index d469dc1c40..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-resources.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List resources"
-openapi: "GET /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}/resources"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-scans.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-scans.mdx
deleted file mode 100644
index 6d3576af9f..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-scans.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List scans"
-openapi: "GET /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}/scans"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list.mdx
deleted file mode 100644
index f75e3c2b74..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/list.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List"
-openapi: "GET /api/v2/secret-scanning/data-sources/bitbucket"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan-resource.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan-resource.mdx
deleted file mode 100644
index d7ed2e0b5a..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan-resource.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan resource"
-openapi: "POST /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}/resources/{resourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan.mdx
deleted file mode 100644
index f7b7c2dae0..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan"
-openapi: "POST /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/update.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/update.mdx
deleted file mode 100644
index 92a88b6a61..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/bitbucket/update.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Update"
-openapi: "PATCH /api/v2/secret-scanning/data-sources/bitbucket/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/create.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/create.mdx
deleted file mode 100644
index 248c8cf53d..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/create.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Create"
-openapi: "POST /api/v2/secret-scanning/data-sources/github"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/delete.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/delete.mdx
deleted file mode 100644
index eb791e6db6..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/delete.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Delete"
-openapi: "DELETE /api/v2/secret-scanning/data-sources/github/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-id.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-id.mdx
deleted file mode 100644
index 0103ad4471..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-id.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by ID"
-openapi: "GET /api/v2/secret-scanning/data-sources/github/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-name.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-name.mdx
deleted file mode 100644
index 7e1df2b83b..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/get-by-name.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by name"
-openapi: "GET /api/v2/secret-scanning/data-sources/github/data-source-name/{sourceName}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-resources.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-resources.mdx
deleted file mode 100644
index 3172e8aa31..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-resources.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List resources"
-openapi: "GET /api/v2/secret-scanning/data-sources/github/{dataSourceId}/resources"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-scans.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-scans.mdx
deleted file mode 100644
index 544751e56b..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list-scans.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List scans"
-openapi: "GET /api/v2/secret-scanning/data-sources/github/{dataSourceId}/scans"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/list.mdx
deleted file mode 100644
index 951f827a89..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/list.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List"
-openapi: "GET /api/v2/secret-scanning/data-sources/github"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan-resource.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan-resource.mdx
deleted file mode 100644
index 84359079be..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan-resource.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan resource"
-openapi: "POST /api/v2/secret-scanning/data-sources/github/{dataSourceId}/resources/{resourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan.mdx
deleted file mode 100644
index f6b21b485a..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/scan.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan"
-openapi: "POST /api/v2/secret-scanning/data-sources/github/{dataSourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/github/update.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/github/update.mdx
deleted file mode 100644
index 2d800d9d54..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/github/update.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Update"
-openapi: "PATCH /api/v2/secret-scanning/data-sources/github/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/create.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/create.mdx
deleted file mode 100644
index 1ed9f8ceaf..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/create.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Create"
-openapi: "POST /api/v2/secret-scanning/data-sources/gitlab"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/delete.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/delete.mdx
deleted file mode 100644
index 5c26f478d2..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/delete.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Delete"
-openapi: "DELETE /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-id.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-id.mdx
deleted file mode 100644
index 48e9b9fb4a..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-id.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by ID"
-openapi: "GET /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-name.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-name.mdx
deleted file mode 100644
index 9756fd7f26..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-name.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Get by name"
-openapi: "GET /api/v2/secret-scanning/data-sources/gitlab/data-source-name/{sourceName}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-resources.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-resources.mdx
deleted file mode 100644
index adbf58b896..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-resources.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List resources"
-openapi: "GET /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}/resources"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-scans.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-scans.mdx
deleted file mode 100644
index d444777fb0..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list-scans.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List scans"
-openapi: "GET /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}/scans"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list.mdx
deleted file mode 100644
index 2d6ffbed30..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/list.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List"
-openapi: "GET /api/v2/secret-scanning/data-sources/gitlab"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan-resource.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan-resource.mdx
deleted file mode 100644
index 085f38d83c..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan-resource.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan resource"
-openapi: "POST /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}/resources/{resourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan.mdx
deleted file mode 100644
index 5ccad9c165..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/scan.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Scan"
-openapi: "POST /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}/scan"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/update.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/update.mdx
deleted file mode 100644
index e48ee40d11..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/gitlab/update.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Update"
-openapi: "PATCH /api/v2/secret-scanning/data-sources/gitlab/{dataSourceId}"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/list.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/list.mdx
deleted file mode 100644
index 0958dc3822..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/list.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List"
-openapi: "GET /api/v2/secret-scanning/data-sources"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/data-sources/options.mdx b/docs/api-reference/endpoints/secret-scanning/data-sources/options.mdx
deleted file mode 100644
index 3affb5270f..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/data-sources/options.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Options"
-openapi: "GET /api/v2/secret-scanning/data-sources/options"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/findings/list.mdx b/docs/api-reference/endpoints/secret-scanning/findings/list.mdx
deleted file mode 100644
index 6a97a3a205..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/findings/list.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "List"
-openapi: "GET /api/v2/secret-scanning/findings"
----
diff --git a/docs/api-reference/endpoints/secret-scanning/findings/update.mdx b/docs/api-reference/endpoints/secret-scanning/findings/update.mdx
deleted file mode 100644
index 1c9614f8bb..0000000000
--- a/docs/api-reference/endpoints/secret-scanning/findings/update.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
----
-title: "Update"
-openapi: "PATCH /api/v2/secret-scanning/findings/{findingId}"
----
\ No newline at end of file
diff --git a/docs/docs.json b/docs/docs.json
index 1924ba2945..a397a00fd7 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -4301,78 +4301,6 @@
}
]
},
- {
- "group": "Secret scanning",
- "boost": 0.25,
- "pages": [
- {
- "group": "Data sources",
- "pages": [
- "api-reference/endpoints/secret-scanning/data-sources/list",
- "api-reference/endpoints/secret-scanning/data-sources/options",
- {
- "group": "Bitbucket",
- "pages": [
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/list",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-id",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/get-by-name",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-resources",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/list-scans",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/create",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/update",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/delete",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan",
- "api-reference/endpoints/secret-scanning/data-sources/bitbucket/scan-resource"
- ]
- },
- {
- "group": "GitHub",
- "pages": [
- "api-reference/endpoints/secret-scanning/data-sources/github/list",
- "api-reference/endpoints/secret-scanning/data-sources/github/get-by-id",
- "api-reference/endpoints/secret-scanning/data-sources/github/get-by-name",
- "api-reference/endpoints/secret-scanning/data-sources/github/list-resources",
- "api-reference/endpoints/secret-scanning/data-sources/github/list-scans",
- "api-reference/endpoints/secret-scanning/data-sources/github/create",
- "api-reference/endpoints/secret-scanning/data-sources/github/update",
- "api-reference/endpoints/secret-scanning/data-sources/github/delete",
- "api-reference/endpoints/secret-scanning/data-sources/github/scan",
- "api-reference/endpoints/secret-scanning/data-sources/github/scan-resource"
- ]
- },
- {
- "group": "GitLab",
- "pages": [
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/list",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-id",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/get-by-name",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/list-resources",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/list-scans",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/create",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/update",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/delete",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/scan",
- "api-reference/endpoints/secret-scanning/data-sources/gitlab/scan-resource"
- ]
- }
- ]
- },
- {
- "group": "Findings",
- "pages": [
- "api-reference/endpoints/secret-scanning/findings/list",
- "api-reference/endpoints/secret-scanning/findings/update"
- ]
- },
- {
- "group": "Configuration",
- "pages": [
- "api-reference/endpoints/secret-scanning/config/get-by-project-id",
- "api-reference/endpoints/secret-scanning/config/update"
- ]
- }
- ]
- },
{
"group": "Secret sharing",
"boost": 0.25,
diff --git a/docs/documentation/platform/secret-scanning/bitbucket.mdx b/docs/documentation/platform/secret-scanning/bitbucket.mdx
index 420c5aa502..f573077cc1 100644
--- a/docs/documentation/platform/secret-scanning/bitbucket.mdx
+++ b/docs/documentation/platform/secret-scanning/bitbucket.mdx
@@ -10,91 +10,37 @@ description: "Learn how to configure secret scanning for Bitbucket."
## Create a Bitbucket data source in Infisical
-<Tabs>
- <Tab title="Infisical UI">
- 1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
- ![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
+1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
+![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
- 2. Select the **Bitbucket** option.
+2. Select the **Bitbucket** option.
- ![Select Bitbucket](/images/platform/secret-scanning/bitbucket/step-2.png)
+![Select Bitbucket](/images/platform/secret-scanning/bitbucket/step-2.png)
- 3. Configure which workspace and repositories you would like to scan. Then click **Next**.
- ![Data Source Configuration](/images/platform/secret-scanning/bitbucket/step-3.png)
+3. Configure which workspace and repositories you would like to scan. Then click **Next**.
+![Data Source Configuration](/images/platform/secret-scanning/bitbucket/step-3.png)
- - **Bitbucket Connection** - the connection that has access to the repositories you want to scan.
- - **Workspace** - the Bitbucket workspace to scan secrets in.
- - **Scan Repositories** - select which repositories you would like to scan.
- - **All Repositories** - Infisical will scan all repositories associated with your connection.
- - **Select Repositories** - Infisical will scan the selected repositories.
- - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
+ - **Bitbucket Connection** - the connection that has access to the repositories you want to scan.
+ - **Workspace** - the Bitbucket workspace to scan secrets in.
+ - **Scan Repositories** - select which repositories you would like to scan.
+ - **All Repositories** - Infisical will scan all repositories associated with your connection.
+ - **Select Repositories** - Infisical will scan the selected repositories.
+ - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
- 4. Give your data source a name and description (optional). Then click **Next**.
- ![Data Source Details](/images/platform/secret-scanning/bitbucket/step-4.png)
+4. Give your data source a name and description (optional). Then click **Next**.
+![Data Source Details](/images/platform/secret-scanning/bitbucket/step-4.png)
- - **Name** - the name of the data source. Must be slug-friendly.
- - **Description** (optional) - a description of this data source.
+ - **Name** - the name of the data source. Must be slug-friendly.
+ - **Description** (optional) - a description of this data source.
- 5. Review your data source, then click **Create Data Source**.
- ![Data Source Review](/images/platform/secret-scanning/bitbucket/step-5.png)
+5. Review your data source, then click **Create Data Source**.
+![Data Source Review](/images/platform/secret-scanning/bitbucket/step-5.png)
- 6. Your **Bitbucket Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
- ![Data Source Created](/images/platform/secret-scanning/bitbucket/step-6.png)
+6. Your **Bitbucket Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
+![Data Source Created](/images/platform/secret-scanning/bitbucket/step-6.png)
- 7. You can view repositories and scan results by clicking on your data source.
- ![Data Source Page](/images/platform/secret-scanning/bitbucket/step-7.png)
+7. You can view repositories and scan results by clicking on your data source.
+![Data Source Page](/images/platform/secret-scanning/bitbucket/step-7.png)
- 8. In addition, you can review any findings from the **Findings Page**.
- ![Findings Page](/images/platform/secret-scanning/bitbucket/step-8.png)
- </Tab>
- <Tab title="API">
- To create a Bitbucket Data Source, make an API request to the [Create Bitbucket Data Source](/api-reference/endpoints/secret-scanning/data-sources/bitbucket/create) API endpoint.
-
- ### Sample request
-
- ```bash Request
- curl --request POST \
- --url https://us.infisical.com/api/v2/secret-scanning/data-sources/bitbucket \
- --header 'Content-Type: application/json' \
- --data '{
- "name": "my-bitbucket-source",
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "description": "my bitbucket data source",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "isAutoScanEnabled": true,
- "config": {
- "workspaceSlug": "my-workspace",
- "includeRepos": ["*"]
- }
- }'
- ```
-
- ### Sample response
-
- ```bash Response
- {
- "dataSource": {
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "externalId": "1234567890",
- "name": "my-bitbucket-source",
- "description": "my bitbucket data source",
- "isAutoScanEnabled": true,
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "createdAt": "2023-11-07T05:31:56Z",
- "updatedAt": "2023-11-07T05:31:56Z",
- "type": "bitbucket",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "connection": {
- "app": "bitbucket",
- "name": "my-bitbucket-app",
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
- },
- "config": {
- "workspaceSlug": "my-workspace",
- "includeRepos": ["*"]
- }
- }
- }
- ```
- </Tab>
-</Tabs>
+8. In addition, you can review any findings from the **Findings Page**.
+![Findings Page](/images/platform/secret-scanning/bitbucket/step-8.png)
diff --git a/docs/documentation/platform/secret-scanning/github.mdx b/docs/documentation/platform/secret-scanning/github.mdx
index 638878f8e0..601774512a 100644
--- a/docs/documentation/platform/secret-scanning/github.mdx
+++ b/docs/documentation/platform/secret-scanning/github.mdx
@@ -10,87 +10,35 @@ description: "Learn how to configure secret scanning for GitHub."
## Create a GitHub data source in Infisical
-<Tabs>
- <Tab title="Infisical UI">
- 1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
- ![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
+1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
+![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
- 2. Select the **GitHub** option.
- ![Select GitHub Option](/images/platform/secret-scanning/github/github-data-source-step-2.png)
+2. Select the **GitHub** option.
+![Select GitHub Option](/images/platform/secret-scanning/github/github-data-source-step-2.png)
- 3. Select the **GitHub Radar Connection** to use and configure which repositories you would like to scan. Then click **Next**.
- ![Data Source Configuration](/images/platform/secret-scanning/github/github-data-source-step-3.png)
+3. Select the **GitHub Radar Connection** to use and configure which repositories you would like to scan. Then click **Next**.
+![Data Source Configuration](/images/platform/secret-scanning/github/github-data-source-step-3.png)
- - **GitHub Radar Connection** - the connection that has access to the repositories you want to scan.
- - **Scan Repositories** - select which repositories you would like to scan.
- - **All Repositories** - Infisical will scan all repositories associated with your connection.
- - **Select Repositories** - Infisical will scan the selected repositories.
- - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
+ - **GitHub Radar Connection** - the connection that has access to the repositories you want to scan.
+ - **Scan Repositories** - select which repositories you would like to scan.
+ - **All Repositories** - Infisical will scan all repositories associated with your connection.
+ - **Select Repositories** - Infisical will scan the selected repositories.
+ - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
- 4. Give your data source a name and description (optional). Then click **Next**.
- ![Data Source Details](/images/platform/secret-scanning/github/github-data-source-step-4.png)
+4. Give your data source a name and description (optional). Then click **Next**.
+![Data Source Details](/images/platform/secret-scanning/github/github-data-source-step-4.png)
- - **Name** - the name of the data source. Must be slug-friendly.
- - **Description** (optional) - a description of this data source.
+ - **Name** - the name of the data source. Must be slug-friendly.
+ - **Description** (optional) - a description of this data source.
- 5. Review your data source, then click **Create Data Source**.
- ![Data Source Review](/images/platform/secret-scanning/github/github-data-source-step-5.png)
+5. Review your data source, then click **Create Data Source**.
+![Data Source Review](/images/platform/secret-scanning/github/github-data-source-step-5.png)
- 6. Your **GitHub Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
- ![Data Source Created](/images/platform/secret-scanning/github/github-data-source-step-6.png)
+6. Your **GitHub Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
+![Data Source Created](/images/platform/secret-scanning/github/github-data-source-step-6.png)
- 7. You can view repositories and scan results by clicking on your data source.
- ![Data Source Page](/images/platform/secret-scanning/github/github-data-source-step-7.png)
+7. You can view repositories and scan results by clicking on your data source.
+![Data Source Page](/images/platform/secret-scanning/github/github-data-source-step-7.png)
- 8. In addition, you can review any findings from the **Findings Page**.
- ![Findings Page](/images/platform/secret-scanning/github/github-data-source-step-8.png)
- </Tab>
- <Tab title="API">
- To create a GitHub Data Source, make an API request to the [Create GitHub Data Source](/api-reference/endpoints/secret-scanning/data-sources/github/create) API endpoint.
-
- ### Sample request
-
- ```bash Request
- curl --request POST \
- --url https://us.infisical.com/api/v2/secret-scanning/data-sources/github \
- --header 'Content-Type: application/json' \
- --data '{
- "name": "my-github-source",
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "description": "my github data source",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "isAutoScanEnabled": true,
- "config": {
- "includeRepos": ["*"]
- }
- }'
- ```
-
- ### Sample response
-
- ```bash Response
- {
- "dataSource": {
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "externalId": "1234567890",
- "name": "my-github-source",
- "description": "my github data source",
- "isAutoScanEnabled": true,
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "createdAt": "2023-11-07T05:31:56Z",
- "updatedAt": "2023-11-07T05:31:56Z",
- "type": "github",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "connection": {
- "app": "github-radar",
- "name": "my-radar-app",
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
- },
- "config": {
- "includeRepos": ["*"]
- }
- }
- }
- ```
- </Tab>
-</Tabs>
+8. In addition, you can review any findings from the **Findings Page**.
+![Findings Page](/images/platform/secret-scanning/github/github-data-source-step-8.png)
diff --git a/docs/documentation/platform/secret-scanning/gitlab.mdx b/docs/documentation/platform/secret-scanning/gitlab.mdx
index ded34ec3f8..369a4a0409 100644
--- a/docs/documentation/platform/secret-scanning/gitlab.mdx
+++ b/docs/documentation/platform/secret-scanning/gitlab.mdx
@@ -10,94 +10,38 @@ description: "Learn how to configure secret scanning for GitLab."
## Create a GitLab data source in Infisical
-<Tabs>
- <Tab title="Infisical UI">
- 1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
- ![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
+1. Navigate to your Secret Scanning Project's Dashboard and select the **Add Data Source** button.
+![Secret Scanning Dashboard](/images/platform/secret-scanning/github/github-data-source-step-1.png)
- 2. Select the **GitLab** option.
- ![Select GitLab](/images/platform/secret-scanning/gitlab/step-2.png)
+2. Select the **GitLab** option.
+![Select GitLab](/images/platform/secret-scanning/gitlab/step-2.png)
- 3. Configure which workspace and repositories you would like to scan. Then click **Next**.
- ![Data Source Configuration](/images/platform/secret-scanning/gitlab/step-3.png)
+3. Configure which workspace and repositories you would like to scan. Then click **Next**.
+![Data Source Configuration](/images/platform/secret-scanning/gitlab/step-3.png)
- - **GitLab Connection** - the connection that has access to the repositories you want to scan.
- - **Scope** - the GitLab scope to scan secrets in.
- - **Project** - scan an individual GitLab project.
- - **Group** - scan one or more projects belonging to a GitLab group.
- - **Scan Repositories** - when using **Group Scope**, select which repositories you would like to scan.
- - **All Repositories** - Infisical will scan all repositories associated with your connection.
- - **Select Repositories** - Infisical will scan the selected repositories.
- - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
+ - **GitLab Connection** - the connection that has access to the repositories you want to scan.
+ - **Scope** - the GitLab scope to scan secrets in.
+ - **Project** - scan an individual GitLab project.
+ - **Group** - scan one or more projects belonging to a GitLab group.
+ - **Scan Repositories** - when using **Group Scope**, select which repositories you would like to scan.
+ - **All Repositories** - Infisical will scan all repositories associated with your connection.
+ - **Select Repositories** - Infisical will scan the selected repositories.
+ - **Auto-Scan Enabled** - whether Infisical should automatically perform a scan when a push is made to configured repositories.
- 4. Give your data source a name and description (optional). Then click **Next**.
- ![Data Source Details](/images/platform/secret-scanning/gitlab/step-4.png)
+4. Give your data source a name and description (optional). Then click **Next**.
+![Data Source Details](/images/platform/secret-scanning/gitlab/step-4.png)
- - **Name** - the name of the data source. Must be slug-friendly.
- - **Description** (optional) - a description of this data source.
+ - **Name** - the name of the data source. Must be slug-friendly.
+ - **Description** (optional) - a description of this data source.
- 5. Review your data source, then click **Create Data Source**.
- ![Data Source Review](/images/platform/secret-scanning/gitlab/step-5.png)
+5. Review your data source, then click **Create Data Source**.
+![Data Source Review](/images/platform/secret-scanning/gitlab/step-5.png)
- 6. Your **GitLab Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
- ![Data Source Created](/images/platform/secret-scanning/gitlab/step-6.png)
+6. Your **GitLab Data Source** is now available and will begin a full scan if **Auto-Scan** is enabled.
+![Data Source Created](/images/platform/secret-scanning/gitlab/step-6.png)
- 7. You can view repositories and scan results by clicking on your data source.
- ![Data Source Page](/images/platform/secret-scanning/gitlab/step-7.png)
+7. You can view repositories and scan results by clicking on your data source.
+![Data Source Page](/images/platform/secret-scanning/gitlab/step-7.png)
- 8. In addition, you can review any findings from the **Findings Page**.
- ![Findings Page](/images/platform/secret-scanning/gitlab/step-8.png)
- </Tab>
- <Tab title="API">
- To create a GitLab Data Source, make an API request to the [Create GitLab Data Source](/api-reference/endpoints/secret-scanning/data-sources/gitlab/create) API endpoint.
-
- ### Sample request
-
- ```bash Request
- curl --request POST \
- --url https://us.infisical.com/api/v2/secret-scanning/data-sources/gitlab \
- --header 'Content-Type: application/json' \
- --data '{
- "name": "my-gitlab-source",
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "description": "my gitlab data source",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "isAutoScanEnabled": true,
- "config": {
- "scope": "project",
- "projectId": 123456789,
- "projectName": "my-group/my-project"
- }
- }'
- ```
-
- ### Sample response
-
- ```bash Response
- {
- "dataSource": {
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "externalId": "1234567890",
- "name": "my-gitlab-source",
- "description": "my gitlab data source",
- "isAutoScanEnabled": true,
- "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "createdAt": "2023-11-07T05:31:56Z",
- "updatedAt": "2023-11-07T05:31:56Z",
- "type": "gitlab",
- "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
- "connection": {
- "app": "gitlab",
- "name": "my-gitlab-app",
- "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
- },
- "config": {
- "scope": "project",
- "projectId": 123456789,
- "projectName": "my-group/my-project"
- }
- }
- }
- ```
- </Tab>
-</Tabs>
+8. In addition, you can review any findings from the **Findings Page**.
+![Findings Page](/images/platform/secret-scanning/gitlab/step-8.png)