Skip to main content
GET
List secrets

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
string<int64>
required

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Example:

123

Query Parameters

cursor
string

Cursor to paginate through the rules. Provide a cursor value from the response to retrieve the next page.

limit
integer<int64>

Page size to paginate through the results.

since
string<date-time>
validationState
enum<string>[]

Whether the finding was validated or not.

  • VALIDATION_STATE_UNSPECIFIED: Return results for all validation states (can also omit this parameter).
  • VALIDATION_STATE_CONFIRMED_VALID: Secret has been tested and is confirmed valid.
  • VALIDATION_STATE_CONFIRMED_INVALID: Secret has been tested and is confirmed invalid.
  • VALIDATION_STATE_VALIDATION_ERROR: Secret test was attempted and there was an error.
  • VALIDATION_STATE_NO_VALIDATOR: There is no validator for this secret.
Available options:
VALIDATION_STATE_UNSPECIFIED,
VALIDATION_STATE_CONFIRMED_VALID,
VALIDATION_STATE_CONFIRMED_INVALID,
VALIDATION_STATE_VALIDATION_ERROR,
VALIDATION_STATE_NO_VALIDATOR
status
enum<string>
default:FINDING_STATUS_UNSPECIFIED

Status of the finding.

  • FINDING_STATUS_UNSPECIFIED: Return results for all finding statuses (if used as a parameter).
  • FINDING_STATUS_OPEN: Finding is open and needs to be triaged
  • FINDING_STATUS_IGNORED: Finding has been triaged and is being ignored
  • FINDING_STATUS_FIXED: Finding has been fixed
  • FINDING_STATUS_REMOVED: Finding has been removed
  • FINDING_STATUS_UNKNOWN: Finding status is unknown
Available options:
FINDING_STATUS_UNSPECIFIED,
FINDING_STATUS_OPEN,
FINDING_STATUS_IGNORED,
FINDING_STATUS_FIXED,
FINDING_STATUS_REMOVED,
FINDING_STATUS_UNKNOWN,
FINDING_STATUS_PROVISIONALLY_IGNORED
severity
enum<string>[]

Severity of the finding.

  • SEVERITY_UNSPECIFIED: Return results for all severities (if used as a parameter).
Available options:
SEVERITY_UNSPECIFIED,
SEVERITY_HIGH,
SEVERITY_MEDIUM,
SEVERITY_LOW,
SEVERITY_CRITICAL
repo
string[]

Repositories to view results for. If not specified, returns all.

Response

200 - application/json

OK

cursor
string

Cursor to paginate through the results.

findings
object[]

List of Secrets associated with the given Deployment.

Example:
previous
string

Cursor to paginate backwards through the results.