---
title: "Secret Exposure Snapshot"
method: POST
path: "/api/v2/issues/exposureSnapshot"
tags: ["Issues"]
---

# Secret Exposure Snapshot

`POST /api/v2/issues/exposureSnapshot`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v2/issues/exposureSnapshot`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

Point-in-time exposure snapshot of a hardcoded-credential finding: who could read the repository on the VCS and who could open the finding in ZeroPath, as recorded when ZeroPath first detected it. A lower bound on exposure. Readable by organization admins and organization-wide credentials; other viewers receive state 'restricted'.

## Request body

- IssuesGetInput
  - `organizationId` string
  - `issueId` string, required

## Response `200`

The exposure snapshot, or the state that explains why none is shown

- union
  - object
    - `state` 'not_applicable', required
  - object
    - `state` 'restricted', required
  - object
    - `state` 'predates_feature', required
  - object
    - `state` 'pending', required
  - object
    - `state` 'failed', required
  - object
    - `state` 'not_recorded', required
  - object
    - `state` 'available', required
    - `snapshot` object, required
      - `takenAt` string, required
      - `verifiedLiveAtDetection` boolean, required
      - `vcsAccess` union, required
        - object
          - `completeness` 'COMPLETE', required
          - `observedAt` string, required
          - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZURE_DEVOPS' | 'GERRIT' | 'GENERIC_GIT' | 'CVS', required
          - `method` string, required
          - `visibilityGrant` 'NONE' | 'EVERYONE' | 'ENTERPRISE_MEMBERS' | 'ALL_INSTANCE_USERS', required
          - `entries` object[], required
            - `externalUserId` string, required
            - `login` string, required
            - `displayName` string, nullable, required
            - `email` string, nullable, required
            - `permission` string, required
            - `sources` string[], required
            - `viaTeams` string[], required
            - `viaOrgRoles` string[], required
        - object
          - `completeness` 'PARTIAL', required
          - `observedAt` string, required
          - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZURE_DEVOPS' | 'GERRIT' | 'GENERIC_GIT' | 'CVS', required
          - `method` string, required
          - `incompleteReasons` string[], required
          - `visibilityGrant` 'NONE' | 'EVERYONE' | 'ENTERPRISE_MEMBERS' | 'ALL_INSTANCE_USERS', required
          - `entries` object[], required
            - `externalUserId` string, required
            - `login` string, required
            - `displayName` string, nullable, required
            - `email` string, nullable, required
            - `permission` string, required
            - `sources` string[], required
            - `viaTeams` string[], required
            - `viaOrgRoles` string[], required
        - object
          - `completeness` 'UNAVAILABLE', required
          - `observedAt` string, required
          - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZURE_DEVOPS' | 'GERRIT' | 'GENERIC_GIT' | 'CVS', nullable, required
          - `method` string, nullable, required
          - `incompleteReasons` string[], required
          - `visibilityGrant` 'NONE' | 'EVERYONE' | 'ENTERPRISE_MEMBERS' | 'ALL_INSTANCE_USERS', nullable, required
      - `zeroPathViewers` union, required
        - object
          - `orphaned` true, required
          - `observedAt` string, required
          - `method` string, required
        - object
          - `orphaned` false, required
          - `observedAt` string, required
          - `method` string, required
          - `organizationId` string, required
          - `organizationName` string, required
          - `accessControlEnabled` boolean, required
          - `alwaysRedactSecrets` boolean, required
          - `entries` object[], required
            - `principalKind` 'MEMBER' | 'MSP_MEMBER' | 'SERVICE_TOKEN' | 'MSP_TOKEN', required
            - `userId` string, nullable, required
            - `apiTokenId` string, nullable, required
            - `displayName` string, nullable, required
            - `role` string, nullable, required
            - `bases` string[], required
            - `canReadNarrative` boolean, required

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api/revisions/126e9c80ba0d?raw)
