Infisical Secret Scanning API
The Secret Scanning API from Infisical — 26 operation(s) for secret scanning.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Secret Scanning API
description: List of all available APIs that can be consumed
version: 0.0.1
servers:
- url: https://us.infisical.com
description: Production server (US)
- url: https://eu.infisical.com
description: Production server (EU)
- url: http://localhost:8080
description: Local server
tags:
- name: Secret Scanning
paths:
/api/v2/secret-scanning/data-sources/options:
get:
operationId: listSecretScanningDataSourceOptions
tags:
- Secret Scanning
description: List the available Secret Scanning Data Source Options.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
dataSourceOptions:
type: array
items:
anyOf:
- type: object
properties:
name:
type: string
enum:
- GitHub
connection:
type: string
enum:
- github-radar
type:
type: string
enum:
- github
required:
- name
- connection
- type
additionalProperties: false
title: GitHub
- type: object
properties:
name:
type: string
enum:
- Bitbucket
connection:
type: string
enum:
- bitbucket
type:
type: string
enum:
- bitbucket
required:
- name
- connection
- type
additionalProperties: false
title: Bitbucket
- type: object
properties:
name:
type: string
enum:
- GitLab
connection:
type: string
enum:
- gitlab
type:
type: string
enum:
- gitlab
required:
- name
- connection
- type
additionalProperties: false
title: GitLab
required:
- dataSourceOptions
additionalProperties: false
'400':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 400
message:
type: string
error:
type: string
details: {}
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 401
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'403':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 403
message:
type: string
details: {}
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'404':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 404
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'422':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 422
message: {}
error:
type: string
required:
- reqId
- statusCode
- error
additionalProperties: false
'500':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 500
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
/api/v2/secret-scanning/data-sources:
get:
operationId: listSecretScanningDataSources
tags:
- Secret Scanning
description: List all the Secret Scanning Data Sources for the specified project.
parameters:
- schema:
type: string
minLength: 1
in: query
name: projectId
required: true
description: The ID of the project to list Scanning Data Sources from.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
dataSources:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
format: uuid
externalId:
type: string
nullable: true
name:
type: string
description:
type: string
nullable: true
encryptedCredentials:
nullable: true
isAutoScanEnabled:
type: boolean
default: true
nullable: true
projectId:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
isDisconnected:
type: boolean
default: false
type:
type: string
enum:
- github
connectionId:
type: string
format: uuid
connection:
type: object
properties:
app:
type: string
enum:
- github-radar
name:
type: string
id:
type: string
format: uuid
required:
- app
- name
- id
additionalProperties: false
config:
type: object
properties:
includeRepos:
type: array
items:
type: string
minLength: 1
maxLength: 256
minItems: 1
maxItems: 100
default:
- '*'
description: The repositories to include when scanning. Defaults to all repositories (["*"]).
additionalProperties: false
required:
- id
- name
- projectId
- createdAt
- updatedAt
- type
- connectionId
- connection
- config
additionalProperties: false
title: GitHub
- type: object
properties:
id:
type: string
format: uuid
externalId:
type: string
nullable: true
name:
type: string
description:
type: string
nullable: true
encryptedCredentials:
nullable: true
isAutoScanEnabled:
type: boolean
default: true
nullable: true
projectId:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
isDisconnected:
type: boolean
default: false
type:
type: string
enum:
- bitbucket
connectionId:
type: string
format: uuid
connection:
type: object
properties:
app:
type: string
enum:
- bitbucket
name:
type: string
id:
type: string
format: uuid
required:
- app
- name
- id
additionalProperties: false
config:
type: object
properties:
workspaceSlug:
type: string
minLength: 1
maxLength: 128
description: The workspace to scan.
includeRepos:
type: array
items:
type: string
minLength: 1
maxLength: 256
minItems: 1
maxItems: 100
default:
- '*'
description: The repositories to include when scanning. Defaults to all repositories (["*"]).
required:
- workspaceSlug
additionalProperties: false
required:
- id
- name
- projectId
- createdAt
- updatedAt
- type
- connectionId
- connection
- config
additionalProperties: false
title: Bitbucket
- type: object
properties:
id:
type: string
format: uuid
externalId:
type: string
nullable: true
name:
type: string
description:
type: string
nullable: true
encryptedCredentials:
nullable: true
isAutoScanEnabled:
type: boolean
default: true
nullable: true
projectId:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
isDisconnected:
type: boolean
default: false
type:
type: string
enum:
- gitlab
connectionId:
type: string
format: uuid
connection:
type: object
properties:
app:
type: string
enum:
- gitlab
name:
type: string
id:
type: string
format: uuid
required:
- app
- name
- id
additionalProperties: false
config:
anyOf:
- type: object
properties:
scope:
type: string
enum:
- group
description: The GitLab scope scanning should occur at (project or group level).
groupId:
type: number
description: The ID of the group to scan projects from.
groupName:
type: string
maxLength: 256
description: The name of the group to scan projects from.
includeProjects:
type: array
items:
type: string
minLength: 1
maxLength: 256
minItems: 1
maxItems: 100
default:
- '*'
description: The projects to include when scanning. Defaults to all projects (["*"]).
required:
- scope
- groupId
additionalProperties: false
- type: object
properties:
scope:
type: string
enum:
- project
description: The GitLab scope scanning should occur at (project or group level).
projectName:
type: string
maxLength: 256
description: The name of the project to scan.
projectId:
type: number
description: The ID of the project to scan.
required:
- scope
- projectId
additionalProperties: false
required:
- id
- name
- projectId
- createdAt
- updatedAt
- type
- connectionId
- connection
- config
additionalProperties: false
title: GitLab
required:
- dataSources
additionalProperties: false
'400':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 400
message:
type: string
error:
type: string
details: {}
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 401
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'403':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 403
message:
type: string
details: {}
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'404':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 404
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
'422':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 422
message: {}
error:
type: string
required:
- reqId
- statusCode
- error
additionalProperties: false
'500':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
statusCode:
type: number
enum:
- 500
message:
type: string
error:
type: string
required:
- reqId
- statusCode
- message
- error
additionalProperties: false
/api/v2/secret-scanning/findings:
get:
operationId: listSecretScanningFindings
tags:
- Secret Scanning
description: List all the Secret Scanning Findings for the specified project.
parameters:
- schema:
type: string
minLength: 1
in: query
name: projectId
required: true
description: The ID of the project to list Secret Scanning Findings from.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
findings:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
format: uuid
dataSourceName:
type: string
resourceName:
type: string
rule:
type: string
severity:
type: string
status:
type: string
default: unresolved
remarks:
type: string
nullable: true
fingerprint:
type: string
projectId:
type: string
scanId:
type: string
format: uuid
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
resourceType:
type: string
enum:
- repository
dataSourceType:
type: string
enum:
- github
details:
type: object
properties:
description:
type: string
startLine:
type: number
endLine:
type: number
startColumn:
type: number
endColumn:
type: number
file:
type: string
link:
type: string
symlinkFile:
type: string
commit:
type: string
entropy:
type: number
author:
type: string
email:
type: string
date:
type: string
message:
type: string
tags:
type: array
items:
type: string
ruleID:
type: string
fingerprint:
type: string
required:
- description
- startLine
- endLine
- startColumn
- endColumn
- file
- link
- symlinkFile
- commit
- entropy
- author
- email
- date
- message
- tags
- ruleID
- fingerprint
additionalProperties: false
required:
- id
- dataSourceName
- resourceName
- rule
- severity
- fingerprint
- projectId
- createdAt
- updatedAt
- resourceType
- dataSourceType
- details
additionalProperties: false
title: GitHub
- type: object
properties:
id:
type: string
format: uuid
dataSourceName:
type: string
resourceName:
type: string
rule:
type: string
severity:
type: string
status:
type: string
default: unresolved
remarks:
type: string
nullable: true
fingerprint:
type: string
projectId:
type: string
scanId:
type: string
format: uuid
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
resourceType:
type: string
enum:
- repository
dataSourceType:
type: string
enum:
- bitbucket
details:
type: object
properties:
description:
type: string
startLine:
type: number
endLine:
type: number
startColumn:
type: number
endColumn:
type: number
file:
type: string
link:
type: string
symlinkFile:
type: string
commit:
type: string
entropy:
type: number
author:
type: string
email:
type: string
date:
type: string
message:
type: string
tags:
type: array
items:
type: string
ruleID:
type: string
fingerprint:
type: string
required:
- description
- startLine
- endLine
# --- truncated at 32 KB (331 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-secret-scanning-api-openapi.yml