> ## Documentation Index
> Fetch the complete documentation index at: https://docs.endorlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetExploitValidationRecord

> Returns a specified exploit validation record.



## OpenAPI

````yaml /api-reference/openapi.v3.json get /v1/namespaces/{tenant_meta.namespace}/exploit-validation-records/{uuid}
openapi: 3.0.3
info:
  description: Integrate your application with Endor Labs using the REST API.
  title: Endor Labs REST API Reference
  version: '1.0'
servers:
  - description: US (default)
    url: https://api.endorlabs.com
  - description: EU (data residency)
    url: https://api.eu.endorlabs.com
security: []
tags:
  - name: AIProviderKeyService
  - name: AISastCustomerContextService
  - name: APIKeyService
  - name: APIKeyValidatorService
  - name: AgentHookPolicyDefinitionService
  - name: AgentTelemetryService
  - name: ArtifactSignatureService
  - name: AsyncJobService
  - name: AuditLogService
  - name: AuthenticationLogService
  - name: AuthenticationService
  - name: AuthorizationPolicyService
  - name: BatchFileSegmentsService
  - name: BatchNotificationService
  - name: CallGraphDataService
  - name: CodeOwnersService
  - name: DependencyMetadataService
  - name: EndorIgnoreEntryService
  - name: ExploitValidationRecordService
  - name: ExporterService
  - name: FindingLogService
  - name: FindingService
  - name: HuggingFaceModelService
  - name: HuggingFaceOrganizationService
  - name: IPAddressPolicyService
  - name: IdentityProviderService
  - name: ImporterService
  - name: InstallationService
  - name: InvitationService
  - name: LicenseDependencyService
  - name: LicenseNoticesReportService
  - name: LicenseSummaryService
  - name: LinterResultService
  - name: MalwareExposureQueryService
  - name: MalwareExposureService
  - name: MalwareService
  - name: MetricService
  - name: NamespaceService
  - name: NotificationService
  - name: NotificationTargetService
  - name: OnPremSchedulerService
  - name: PRCommentConfigService
  - name: PackageFirewallLogService
  - name: PackageLicenseOverrideService
  - name: PackageLicenseQueryService
  - name: PackageLicenseService
  - name: PackageManagerService
  - name: PackageVersionService
  - name: PluginBinaryService
  - name: PolicyService
  - name: PolicyTemplateService
  - name: ProjectService
  - name: ProvisioningResultService
  - name: QueryMalwareService
  - name: QueryService
  - name: QuerySimilarPackagesService
  - name: QueryVulnerabilityService
  - name: RegistryIngestionCheckpointService
  - name: RepositoryService
  - name: RepositoryVersionService
  - name: RuleSetImportService
  - name: SBOMImportService
  - name: SCMCredentialService
  - name: SavedQueryService
  - name: ScanCreditUsageService
  - name: ScanLogRequestService
  - name: ScanProfileService
  - name: ScanResultService
  - name: ScanWorkflowResultService
  - name: ScanWorkflowService
  - name: SecretRuleService
  - name: SemgrepRuleService
  - name: SystemConfigService
  - name: TenantService
  - name: VectorStoreService
  - name: VersionUpgradeService
  - name: VulnerabilityService
paths:
  /v1/namespaces/{tenant_meta.namespace}/exploit-validation-records/{uuid}:
    get:
      tags:
        - ExploitValidationRecordService
      summary: GetExploitValidationRecord
      description: Returns a specified exploit validation record.
      operationId: ExploitValidationRecordService_GetExploitValidationRecord
      parameters:
        - description: >-
            Namespaces are a way to organize organizational units into virtual

            groupings of resources. Namespaces must be a fully qualified name,

            for example, the child namespace of namespace "endor.prod" called
            "app"

            is called "endor.prod.app".
          in: path
          name: tenant_meta.namespace
          required: true
          schema:
            type: string
          x-endor-name: Namespace
        - description: The UUID of the requested resource.
          in: path
          name: uuid
          required: true
          schema:
            type: string
        - description: List of fields to return (all fields are returned by default).
          in: query
          name: get_parameters.mask
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ExploitValidationRecord'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googleRpcStatus'
          description: An unexpected error response.
components:
  schemas:
    v1ExploitValidationRecord:
      description: >-
        An exploit validation record holds a caller's claim about what a
        validation

        run did against a finding. The server does not verify the run. The
        service has

        no update method. A repeat of a stored record's spec can refresh its

        caller-written meta, but the spec, which holds the verdict and the
        evidence,

        never changes. A delete exists to withdraw a wrong or leaked record, and
        among

        the system roles only ADMIN holds it.


        The create path resolves spec.finding_uuid inside this record's own

        namespace, and a reader must do the same. A bare uuid lookup would let a

        record written in one tenant name a finding in another.
      properties:
        meta:
          $ref: '#/components/schemas/v1Meta'
        spec:
          $ref: '#/components/schemas/v1ExploitValidationRecordSpec'
        tenant_meta:
          $ref: '#/components/schemas/v1TenantMeta'
        uuid:
          description: The UUID of the exploit validation record.
          readOnly: true
          type: string
      required:
        - meta
        - spec
      type: object
    googleRpcStatus:
      description: >-
        The `Status` type defines a logical error model that is suitable for

        different programming environments, including REST APIs and RPC APIs. It
        is

        used by [gRPC](https://github.com/grpc). Each `Status` message contains

        three pieces of data: error code, error message, and error details.


        You can find out more about this error model and how to work with it in
        the

        [API Design Guide](https://cloud.google.com/apis/design/errors).
      properties:
        code:
          description: |-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          format: int32
          type: integer
        details:
          description: >-
            A list of messages that carry the error details.  There is a common
            set of

            message types for APIs to use.
          items:
            $ref: '#/components/schemas/googleProtobufAny'
          type: array
        message:
          description: >-
            A developer-facing error message, which should be in English. Any

            user-facing error message should be localized and sent in the

            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized

            by the client.
          type: string
      type: object
    v1Meta:
      description: Common fields for all Endor Labs resources.
      properties:
        annotations:
          additionalProperties:
            type: string
          description: >-
            Annotations can be used to attach metadata to a resource message.

            Annotation values can be small or large, structured or unstructured,

            and may include characters not permitted by labels.

            The keys may contain alphanumerics, underscores (_), dots (.) and
            dashes

            (-). The values of an annotation must be 16384 bytes or smaller.
          type: object
        create_time:
          description: |-
            Time the resource was created.

            Format: 2017-01-15T01:30:15.01Z
            RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
          format: date-time
          readOnly: true
          type: string
        created_by:
          description: |-
            Name and authentication source of the user who created the object,
            for example, ewok@endor.ai@google@api-key.
          readOnly: true
          type: string
        description:
          description: Resource description. Must be less than 1024 bytes.
          type: string
        index_data:
          $ref: '#/components/schemas/v1IndexData'
        kind:
          description: >-
            Resource kind, for example, HelloResponse.

            Auto-generated using the protobuf message
            proto.MessageName().Name().
          readOnly: true
          type: string
        name:
          description: Resource name. Must be 63 characters or less.
          type: string
          x-endor-name: Name
        parent_kind:
          description: Parent object resource kind, for example, Project.
          type: string
          x-endor-name: Parent Resource
        parent_uuid:
          description: Parent object UUID.
          type: string
          x-endor-name: Parent UUID
        references:
          additionalProperties:
            $ref: '#/components/schemas/googleProtobufAny'
          description: Map of objects referenced in a query API.
          readOnly: true
          type: object
        tags:
          description: >-
            List of tags attached to the resource.

            Tags can be used to select objects and to find collections of
            objects that

            satisfy certain conditions. A tag must be 255 characters or less.
          items:
            type: string
          type: array
          x-endor-name: Custom Tags
        update_time:
          description: |-
            Time the resource was last updated.
            Note: Updated on all create/patch/delete operations.

            Format: 2017-01-15T01:30:15.01Z
            RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
          format: date-time
          readOnly: true
          type: string
        updated_by:
          description: >-
            Name and authentication source of the last user who updated the
            object,

            for example, vulnerabilityingestor@endor.ai@x509.
          readOnly: true
          type: string
        upsert_time:
          description: |-
            Time the resource was last upserted.

            Note:
            create_time is only set the first time the resource is created.
            upsert_time is set every time the resource is upseted.

            Format: 2017-01-15T01:30:15.01Z
            RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
          format: date-time
          readOnly: true
          type: string
        version:
          description: Message version.
          readOnly: true
          type: string
      required:
        - name
      type: object
    v1ExploitValidationRecordSpec:
      description: Details of the validation run and what it concluded.
      properties:
        agent_id:
          description: >-
            Catalog id of the agent that ran the validation, recorded verbatim
            from

            the caller. The caller writes these next three fields, so they are

            self-asserted and a caller can put anything in them. They are a
            label for

            a reader, never a trust signal. The server-recorded caller is

            meta.created_by, which the create path stamps and which is
            OUTPUT_ONLY.

            It attributes the call to a caller. It does not attest that the
            named

            agent performed the exploit.
          type: string
          x-endor-name: Agent ID
        evidence:
          description: >-
            What the run observed, in the words of whoever ran it. Free text, so
            a

            reader must treat it as a claim to check rather than as a platform

            finding.
          type: string
          x-endor-name: Evidence
        finding_uuid:
          description: The finding the verdict applies to.
          type: string
          x-endor-name: Finding UUID
        idempotency_key:
          description: >-
            Server-set. A SHA-256 hex digest over the tenant, the caller, the
            action

            and the stored spec. Caller-writable meta, such as meta.name or

            meta.tags, is not part of it. A create from the same caller in the
            same

            tenant whose spec matches a stored record does not add a second one.
            The

            stored record keeps its uuid, its create time and its spec, and
            takes the

            meta of the new request.
          readOnly: true
          type: string
          x-endor-name: Idempotency Key
        on_behalf_of:
          description: |-
            The human principal the agent acted for. A caller with no agent is
            expected to leave it empty. Nothing enforces that.
          type: string
          x-endor-name: On Behalf Of
        reason:
          description: >-
            Why the run proved no exploit, in the words of whoever ran it. The
            create

            path requires it when spec.verdict is VERDICT_NOT_CONFIRMED or

            VERDICT_NOT_ATTEMPTED, and redacts secrets from it before it is
            stored.
          type: string
          x-endor-name: Reason
        scanned_commit_sha:
          description: >-
            The revision the validation ran against. Set it for a finding from a

            repository scan, where the version row is keyed on the branch ref
            and

            upserted in place across commits, so the version uuid alone does not

            identify a revision. It is empty only when the scan produced no
            commit,

            such as an SBOM import. A consumer must then treat the verdict as

            unpinned.
          type: string
          x-endor-name: Scanned Commit SHA
        scanned_version_uuid:
          description: >-
            The version the validated finding was reported on. Server-set: the
            create

            path reads the finding named in spec.finding_uuid and copies that

            finding's own meta.parent_uuid here, so a caller cannot point a
            verdict

            at one finding and file it against another version. Its kind is the

            finding's meta.parent_kind, so a reader never has to probe both
            version

            collections. This uuid locates the scan. It does not pin the code:

            scanned_commit_sha does that when it is set, and nothing does when
            it is

            empty. Deleting the version alone does not delete this record: one
            child

            field cannot name which of the two version kinds owns it, so the
            record

            survives until its project goes.
          readOnly: true
          type: string
          x-endor-name: Scanned Version UUID
        session:
          description: >-
            Per-run agent-session id shared by every call in one agent run. A
            human

            caller is expected to leave it empty. Nothing enforces that.
          type: string
          x-endor-name: Agent Session
        verdict:
          $ref: '#/components/schemas/ExploitValidationRecordVerdict'
      required:
        - finding_uuid
        - verdict
      type: object
    v1TenantMeta:
      description: Tenant related data for the tenant containing the resource.
      properties:
        namespace:
          description: >-
            Namespaces are a way to organize organizational units into virtual

            groupings of resources. Namespaces must be a fully qualified name,

            for example, the child namespace of namespace "endor.prod" called
            "app"

            is called "endor.prod.app".
          type: string
          x-endor-name: Namespace
      required:
        - namespace
      type: object
    googleProtobufAny:
      additionalProperties: {}
      description: >-
        `Any` contains an arbitrary serialized protocol buffer message along
        with a

        URL that describes the type of the serialized message.


        Protobuf library provides support to pack/unpack Any values in the form

        of utility functions or additional generated methods of the Any type.


        Example 1: Pack and unpack a message in C++.

            Foo foo = ...;
            Any any;
            any.PackFrom(foo);
            ...
            if (any.UnpackTo(&foo)) {
              ...
            }

        Example 2: Pack and unpack a message in Java.

            Foo foo = ...;
            Any any = Any.pack(foo);
            ...
            if (any.is(Foo.class)) {
              foo = any.unpack(Foo.class);
            }
            // or ...
            if (any.isSameTypeAs(Foo.getDefaultInstance())) {
              foo = any.unpack(Foo.getDefaultInstance());
            }

         Example 3: Pack and unpack a message in Python.

            foo = Foo(...)
            any = Any()
            any.Pack(foo)
            ...
            if any.Is(Foo.DESCRIPTOR):
              any.Unpack(foo)
              ...

         Example 4: Pack and unpack a message in Go

             foo := &pb.Foo{...}
             any, err := anypb.New(foo)
             if err != nil {
               ...
             }
             ...
             foo := &pb.Foo{}
             if err := any.UnmarshalTo(foo); err != nil {
               ...
             }

        The pack methods provided by protobuf library will by default use

        'type.googleapis.com/full.type.name' as the type URL and the unpack

        methods only use the fully qualified type name after the last '/'

        in the type URL, for example "foo.bar.com/x/y.z" will yield type

        name "y.z".


        JSON

        ====

        The JSON representation of an `Any` value uses the regular

        representation of the deserialized, embedded message, with an

        additional field `@type` which contains the type URL. Example:

            package google.profile;
            message Person {
              string first_name = 1;
              string last_name = 2;
            }

            {
              "@type": "type.googleapis.com/google.profile.Person",
              "firstName": <string>,
              "lastName": <string>
            }

        If the embedded message type is well-known and has a custom JSON

        representation, that representation will be embedded adding a field

        `value` which holds the custom JSON in addition to the `@type`

        field. Example (for message [google.protobuf.Duration][]):

            {
              "@type": "type.googleapis.com/google.protobuf.Duration",
              "value": "1.212s"
            }
      properties:
        '@type':
          description: >-
            A URL/resource name that uniquely identifies the type of the
            serialized

            protocol buffer message. This string must contain at least

            one "/" character. The last segment of the URL's path must represent

            the fully qualified name of the type (as in

            `path/google.protobuf.Duration`). The name should be in a canonical
            form

            (e.g., leading "." is not accepted).


            In practice, teams usually precompile into the binary all types that
            they

            expect it to use in the context of Any. However, for URLs which use
            the

            scheme `http`, `https`, or no scheme, one can optionally set up a
            type

            server that maps type URLs to message definitions as follows:


            * If no scheme is provided, `https` is assumed.

            * An HTTP GET on the URL must yield a [google.protobuf.Type][]
              value in binary format, or produce an error.
            * Applications are allowed to cache lookup results based on the
              URL, or have them precompiled into a binary to avoid any
              lookup. Therefore, binary compatibility needs to be preserved
              on changes to types. (Use versioned type names to manage
              breaking changes.)

            Note: this functionality is not currently available in the official

            protobuf release, and it is not used for type URLs beginning with

            type.googleapis.com. As of May 2023, there are no widely used type
            server

            implementations and no plans to implement one.


            Schemes other than `http`, `https` (or the empty scheme) might be

            used with implementation specific semantics.
          type: string
      type: object
    v1IndexData:
      description: |-
        IndexData is used to index the resource for search. It's an internal
        object.
      properties:
        data:
          items:
            type: string
          readOnly: true
          type: array
        search_score:
          description: >-
            search_score is the score of the resource for search. Internal use
            only.
          format: float
          readOnly: true
          type: number
        tenant:
          readOnly: true
          type: string
        will_be_deleted_at:
          description: Time that the resource will be deleted.
          format: date-time
          readOnly: true
          type: string
      type: object
      x-internal: true
    ExploitValidationRecordVerdict:
      default: VERDICT_UNSPECIFIED
      description: >-
        The conclusion a validation run reached. VERDICT_CONFIRMED is the only

        positive conclusion. VERDICT_NOT_CONFIRMED and VERDICT_NOT_ATTEMPTED are

        inconclusive. Neither ever means that the finding is safe, and no value

        means "safe" or "not exploitable". The inconclusive values must never
        reach

        finding tags or any resource kind that a policy can read, because an

        exception policy could then except a finding on them.

         - VERDICT_UNSPECIFIED: No verdict has been set. The create path rejects it.
         - VERDICT_CONFIRMED: An attack worked against the named target at the stored commit. It proves
        one way to exploit the finding, not every way.
         - VERDICT_NOT_CONFIRMED: An attack was sent and no exploit was proven in this attempt.
         - VERDICT_NOT_ATTEMPTED: No attack was sent.
      enum:
        - VERDICT_UNSPECIFIED
        - VERDICT_CONFIRMED
        - VERDICT_NOT_CONFIRMED
        - VERDICT_NOT_ATTEMPTED
      type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.