---
title: "GetExporter"
method: GET
path: "/v1/namespaces/{tenant_meta.namespace}/exporters/{uuid}"
tags: ["ExporterService"]
---

# GetExporter

`GET /v1/namespaces/{tenant_meta.namespace}/exporters/{uuid}`

## Request

- Base URL: `https://api.endorlabs.com`
- URL: `https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/exporters/{uuid}`
- Auth: none declared

Fetches the exporter identified by the UUID.

## Path parameters

- `tenant_meta.namespace` string, required
- `uuid` string, required

## Query parameters

- `get_parameters.mask` string

## Response `200`

A successful response.

- V1Exporter: Defines a data exporter.
  - `meta` V1Meta, required: Common fields for all Endor Labs resources.
    - `annotations` object: 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.
    - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string: Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float: search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time: Time that the resource will be deleted.
    - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required: Resource name. Must be 63 characters or less.
    - `parent_kind` string: Parent object resource kind, for example, Project.
    - `parent_uuid` string: Parent object UUID.
    - `references` object: Map of objects referenced in a query API.
    - `tags` string[]: 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.
    - `update_time` string, date-time: 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.
    - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time: 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.
    - `version` string: Message version.
  - `propagate` boolean: Indicates whether the object should be visible in the child namespaces or not.
  - `spec` V1ExporterSpec, required
    - `exporter_type` 'EXPORTER_TYPE_UNSPECIFIED' | 'EXPORTER_TYPE_GHAS' | 'EXPORTER_TYPE_S3' | 'EXPORTER_TYPE_WIZ', required: - EXPORTER_TYPE_GHAS: EXPORTER_TYPE_GHAS indicates a GitHub Advanced Security exporter. - EXPORTER_TYPE_S3: EXPORTER_TYPE_S3 indicates an AWS S3 exporter. - EXPORTER_TYPE_WIZ: EXPORTER_TYPE_WIZ indicates a Wiz Security Platform exporter.
    - `message_type_configs` ExporterMessageTypeConfig[]
      - `message_export_format` 'MESSAGE_EXPORT_FORMAT_UNSPECIFIED' | 'MESSAGE_EXPORT_FORMAT_JSON' | 'MESSAGE_EXPORT_FORMAT_SARIF', required: - MESSAGE_EXPORT_FORMAT_JSON: MESSAGE_EXPORT_FORMAT_JSON indicates a JSON message format. - MESSAGE_EXPORT_FORMAT_SARIF: MESSAGE_EXPORT_FORMAT_SARIF indicates a SARIF message format.
      - `message_type` 'MESSAGE_TYPE_UNSPECIFIED' | 'MESSAGE_TYPE_FINDING' | 'MESSAGE_TYPE_PACKAGE_VERSION' | 'MESSAGE_TYPE_PROJECT' | 'MESSAGE_TYPE_SCAN_RESULT' | 'MESSAGE_TYPE_ADMISSION_POLICY_FINDING', required: - MESSAGE_TYPE_FINDING: MESSAGE_TYPE_FINDING indicates a finding message. - MESSAGE_TYPE_PACKAGE_VERSION: MESSAGE_TYPE_PACKAGE_VERSION indicates a package version message. - MESSAGE_TYPE_PROJECT: MESSAGE_TYPE_PROJECT indicates a project message. - MESSAGE_TYPE_SCAN_RESULT: MESSAGE_TYPE_SCAN_RESULT indicates a scan result message. - MESSAGE_TYPE_ADMISSION_POLICY_FINDING: MESSAGE_TYPE_ADMISSION_POLICY_FINDING indicates an admission policy finding message (blocked or warning).
    - `s3_config` ExporterS3Config
      - `allowed_audience` string, required: allowed_audiences is the audience that will be allowed to assume the role.
      - `assume_role_arn` string, required: assume_role_arn is the IAM role ARN that will be assumed to access S3.
      - `bucket_name` string, required: bucket_name is the name of the S3 bucket to export the data to.
      - `compression_format` 'COMPRESSION_FORMAT_UNSPECIFIED' | 'COMPRESSION_FORMAT_ZIP' | 'COMPRESSION_FORMAT_GZIP': Container format of each exported object. Unset keeps the historical format. - COMPRESSION_FORMAT_UNSPECIFIED: Behaves as COMPRESSION_FORMAT_ZIP. - COMPRESSION_FORMAT_ZIP: Historical format: a gzip stream stored under a .zip suffix with content type application/zip. - COMPRESSION_FORMAT_GZIP: A plain gzip stream stored under a .gz suffix with content type application/gzip, readable by Athena and Spark.
      - `object_expiry_days` integer: object_expiry_days is the number of days for which the exported objects will be kept in S3. Deprecated: This field is deprecated and will be removed in a future release. The S3 bucket should be configured with a lifecycle rule to expire objects after a certain number of days.
      - `region` string, required: region is the region to use for the S3 bucket.
    - `wiz_config` ExporterWizConfig
      - `api_endpoint_url` string: api_endpoint_url is the Wiz API endpoint URL.
      - `oauth_client_credentials` V1OAuthClientCredentialsAuthConfig: OAuthClientCredentialsAuthConfig configures OAuth 2.0 client credentials authentication.
        - `auth_endpoint_url` string: auth_endpoint_url is the OAuth token endpoint URL. If not specified, defaults may be vendor-specific.
        - `client_id` string, required: client_id is the OAuth client ID for authentication.
        - `client_secret` string, required: client_secret is the OAuth client secret for authentication. This field is handled securely and stored encrypted.
  - `tenant_meta` V1TenantMeta: Tenant related data for the tenant containing the resource.
    - `namespace` string, required: 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".
  - `uuid` string: The UUID of the exporter.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-11-03** `4acd9fe15140`: 1 info
  - added the optional property `spec/s3_config/compression_format` to the response with the `200` status

[Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/namespaces/:tenant_meta.namespace/exporters/:uuid/get.md)

---

[API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/4acd9fe15140?raw)