Entropy Data

https://docs.entropy-data.com
Admin
Entropy Data is an application to manage data products, data contracts, and global policies,...
Tokens:78,180
Snippets:1,104
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Implement data product prompt example

Source: https://docs.entropy-data.com/data-product-builder/configuration

A template for usage instructions that utilizes dynamic variables to guide coding agents in implementing a data product.

```markdown
### Implement data product

```
Implement the data product {{dataProductId}}.
```text

This prompt will implement the data product in dbt. The plugin analyzes
the linked data contracts as requirements and implements the dbt
pipeline and models accordingly.

```
```

--------------------------------

### Install Entropy Data CLI

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Installation methods using uv or pip, followed by a help command verification.

```bash
uv tool install entropy-data
entropy-data --help
```

```bash
pip install entropy-data
entropy-data --help
```

--------------------------------

### Install Data Contract CLI

Source: https://docs.entropy-data.com/integrations/datacontract-cli

Install the CLI tool using uv or pip. The [all] extra includes all necessary data source connectors.

```bash
uv tool install --python python3.11 --upgrade 'datacontract-cli[all]'
datacontract --version
```

--------------------------------

### Install openlineage-dbt

Source: https://docs.entropy-data.com/howto/lineage

Install the required package to enable OpenLineage event emission from dbt.

```bash
pip install openlineage-dbt
```

--------------------------------

### Report Successful Provisioning

Source: https://docs.entropy-data.com/concepts/provisioning

Example request to mark an access grant as successfully provisioned on a platform.

```bash
curl -X POST 'https://api.entropy-data.com/api/access/orders-analytics/provisioning/provisioning-succeeded' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform": "bigquery",
    "executor": "Orders Access Connector",
    "reference": "projects/acme-prod/roles/orders_analytics_reader",
    "customProperties": [
      { "property": "grantId", "value": "g-9f2c41ab" }
    ],
    "links": { "Run log": "https://connector.example.com/runs/8412" }
  }'
```

--------------------------------

### Install with Helm

Source: https://docs.entropy-data.com/installation-kubernetes

Deploy the application to the Kubernetes cluster using the configured Helm chart.

```bash
helm install entropy-data . \
  --namespace entropy-data \
  --create-namespace
```

--------------------------------

### Directory Layout Convention

Source: https://docs.entropy-data.com/howto/import-export

Example of the folder-as-kind directory structure used by export and apply commands.

```text
org-state/
  teams/                          # folder name = resource kind
    marketing.yaml                # one file per resource (filename is cosmetic)
    finance--legal.yaml
  policies/
    pii-policy.yaml
  datacontracts/
    orders-1-orders.yaml
  semantic-ontology/
    main.yaml                     # document resources: one YAML doc per namespace
  organization-features/
    organization-features.yaml    # singleton: <name>/<name>.yaml
```

--------------------------------

### Connector Startup Logs

Source: https://docs.entropy-data.com/integrations/databricks

Example output logs confirming successful registration and event polling for the Databricks connector.

```text
2025-05-15T07:42:39.596Z  INFO 1 --- [cTaskExecutor-1] e.sdk.EntropyDataEventListener            : databricks-access-management: Start polling for events
2025-05-15T07:42:39.663Z  INFO 1 --- [cTaskExecutor-1] e.sdk.EntropyDataEventListener            : Fetching events with lastEventId=1f030d95-7eeb-67c4-b68c-7f053555cc14
2025-05-15T07:42:39.726Z  INFO 1 --- [           main] e.s.EntropyDataConnectorRegistration     : Registering integration connector databricks-assets
2025-05-15T07:42:39.748Z  INFO 1 --- [cTaskExecutor-1] e.sdk.EntropyDataEventListener            : Processing event 1f030d95-7f45-6d15-b68c-9fcae55fcd9a of type com.datamesh-manager.events.AccessDeactivatedEvent
2025-05-15T07:42:39.753Z  INFO 1 --- [cTaskExecutor-1] e.d.DatabricksAccessManagementHandler    : Processing AccessDeactivatedEvent 5sHEK6r9PydbE5CVpSk9BN
2025-05-15T07:42:39.789Z  INFO 1 --- [cTaskExecutor-2] e.s.EntropyDataAssetsSynchronizer      : databricks-assets: start syncing assets
```

--------------------------------

### Start Entropy Data

Source: https://docs.entropy-data.com/installation-docker

Execute the Docker Compose up command to start the services in detached mode.

```bash
docker compose up --detach
```

--------------------------------

### External ID Examples

Source: https://docs.entropy-data.com/howto/data-contract-versioning

Concrete examples of external IDs following the recommended naming convention.

```text
customer-data_v1
sales-transactions_v2
product-inventory_v3
```

--------------------------------

### Attach example data via cURL

Source: https://docs.entropy-data.com/usage-examples

Use this endpoint to attach sample datasets to data products. The payload is limited to 1 MB and a maximum of 30 rows.

```bash
curl --request PUT https://api.entropy-data.com/api/example-data/customer-cohorts-example \
--header "x-api-key: $ENTROPY_DATA_API_KEY" \
--header "content-type: application/json" \
--data @- << EOF
{
    "id": "customer-cohorts-example",
    "dataProductId": "customer-cohorts",
    "outputPortId": "snowflake-customer-cohorts-v1",
    "schemaName": "customer_cohorts",
    "data": [
        {"CUSTOMER_ID": "CUST-4821", "COHORT_NAME": "high-value"},
        {"CUSTOMER_ID": "CUST-7733", "COHORT_NAME": "churn-risk"}
    ]
}
EOF
```

--------------------------------

### MariaDB Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of defining server fields for a MariaDB asset using custom properties.

```json
{
  "custom": {
    "host": "mariadb.example.com",
    "port": "3306",
    "database": "mydb"
  }
}
```

--------------------------------

### Retrieve Data Products

Source: https://docs.entropy-data.com/quickstart

Perform a GET request to retrieve all data products for the organization using the API key.

```bash
curl --get https://api.entropy-data.com/api/dataproducts \
  --header "x-api-key: $ENTROPY_DATA_API_KEY"
```

--------------------------------

### SQL Server Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of defining server fields for a SQL Server asset using custom properties.

```json
{
  "custom": {
    "host": "sqlserver.example.com",
    "port": "1433",
    "database": "mydb"
  }
}
```

--------------------------------

### MySQL Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of defining server fields for a MySQL asset using custom properties.

```json
{
  "custom": {
    "host": "mysql.example.com",
    "port": "3306",
    "database": "mydb"
  }
}
```

--------------------------------

### Run the Event Listener

Source: https://docs.entropy-data.com/integrations/sdk

Configure and start the listener to poll the event feed. Use a state repository to ensure the integration resumes from the last processed event.

```java
var handler = new AccessHandler(client);
var stateRepository = new EntropyDataStateRepositoryRemote("my-connector", client);
var listener = new EntropyDataEventListener(
    "my-connector", "accessmanagement", client, handler, stateRepository);

listener.start();
```

--------------------------------

### Deploy Databricks Connector via Docker

Source: https://docs.entropy-data.com/integrations/databricks

Command to start the Databricks connector container with required environment variables for workspace and account authentication.

```bash
    docker run \
    -e ENTROPYDATA_CLIENT_APIKEY='dmm_live_5TJYRn6CrsWELldNiffii6oKdYNMuEYWinBoOoxRrvXaLW4y9A5Xck12as9dasw9' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_WORKSPACE_HOST='https://adb-1973318500000000.17.azuredatabricks.net' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_WORKSPACE_CLIENTID='d2e11498-4b63-43cd-9ebe-a00000000000' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_WORKSPACE_CLIENTSECRET='dose79375ba79041c9c5250a190002a71cd9' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_ACCOUNT_HOST='https://accounts.azuredatabricks.net' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_ACCOUNT_ACCOUNTID='4675280120000000' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_ACCOUNT_CLIENTID='d2e11498-4b63-43cd-9ebe-a00000000000' \
    -e ENTROPYDATA_CLIENT_DATABRICKS_ACCOUNT_CLIENTSECRET='dose000000000000c9c5250a190002a71cd9' \
    entropydata/entropy-data-connector-databricks:latest
```

--------------------------------

### GET /api/events

Source: https://docs.entropy-data.com/events

Retrieves a batch of events starting after the specified lastEventId.

```APIDOC
## GET /api/events

### Description
This endpoint allows you to retrieve a batch of events, starting after the `lastEventId`.

### Method
GET

### Endpoint
/api/events

### Parameters
#### Query Parameters
- **lastEventId** (string) - Optional - The `id` (from the CloudEvent envelope) of the last processed event.

### Request Example
curl --request GET \
--url "https://api.entropy-data.com/api/events?lastEventId=1c82203f-f792-4fc3-94cb-59141f1d0793" \
--header "x-api-key: $ENTROPY_DATA_API_KEY"

### Response
#### Success Response (200)
- **Array** (list) - A list of CloudEvent objects.
```

--------------------------------

### Verify cURL Installation

Source: https://docs.entropy-data.com/quickstart

Check if cURL is installed on the local machine.

```bash
# cURL is most likely already installed on your machine
curl --version
```

--------------------------------

### Initialize Entropy Data Client

Source: https://docs.entropy-data.com/integrations/sdk

Create a client instance using the host URL and an API key to access resource APIs.

```java
var client = new EntropyDataClient("https://api.entropy-data.com", apiKey);
```

--------------------------------

### GET /api/v1/lineage

Source: https://docs.entropy-data.com/howto/lineage

Retrieve stored OpenLineage events. All filters are optional; omit all to get every event.

```APIDOC
## GET /api/v1/lineage

### Description
Retrieve stored OpenLineage events. All filters are optional; omit all to get every event.

### Method
GET

### Endpoint
/api/v1/lineage

### Parameters
#### Query Parameters
- **jobNamespace** (string) - Optional - Filter by job namespace.
- **jobName** (string) - Optional - Filter by job name.
- **runId** (string) - Optional - Filter by run ID.
- **eventType** (string) - Optional - Filter by event type: START, RUNNING, COMPLETE, ABORT, FAIL.
- **dataProductId** (string) - Optional - Filter by data product external ID.

### Request Example
curl --get https://api.entropy-data.com/api/v1/lineage \
  --header "x-api-key: $ENTROPY_DATA_API_KEY" \
  --data-urlencode "dataProductId=orders"
```

--------------------------------

### Sync Environments Between Instances

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Commands to preview or execute the promotion of organization state between instances.

```bash
# Preview a test -> prod sync without writing anything
entropy-data sync --source test --target prod --include datacontracts,dataproducts --dry-run

# Promote the selected resources test -> prod
entropy-data sync --source test --target prod --include datacontracts,dataproducts
```

--------------------------------

### Access Rejected Email Template Example

Source: https://docs.entropy-data.com/email-templates

Example of an email body template using conditional logic and variable insertion.

```text
Your access request has been rejected.

{{#if reason}}
Reason: {{reason}}

{{/if}}
If you have any questions, please contact us at {{supportEmail}}.

```

--------------------------------

### Configure via CLI Options

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Pass credentials directly as command-line arguments.

```bash
entropy-data --api-key your-api-key --host https://app.entropy-data.com <command>
```

--------------------------------

### List All Resources

Source: https://docs.entropy-data.com/installation-kubernetes

View all Kubernetes resources within the entropy-data namespace.

```bash
kubectl get all -n entropy-data
```

--------------------------------

### Complex SCIM Group Mapping Example

Source: https://docs.entropy-data.com/scim

A comprehensive example demonstrating multiple group mappings for organization owners and various team roles.

```yaml
scimGroupMappings:
  - scimGroup: "dmm_owners"
    type: "organizationOwner"
  - scimGroup: "dmm_marketing_owners"
    type: "teamMemberRole"
    teamId: "marketing"
    teamMemberRole: "Owner"
  - scimGroup: "dmm_marketing_members"
    type: "teamMemberRole"
    teamId: "marketing"
    teamMemberRole: "Member"
  - scimGroup: "dmm_data_stewards"
    type: "teamMemberRole"
    teamId: "marketing"
    teamMemberRole: "Steward"
  - scimGroup: "dmm_data_stewards"
    type: "teamMemberRole"
    teamId: "sales"
    teamMemberRole: "Steward"
```

--------------------------------

### GET /api/access/:id

Source: https://docs.entropy-data.com/usage-examples

Retrieves the current state of an access resource.

```APIDOC
## GET /api/access/:id

### Description
Returns the current state of an access resource.

### Method
GET

### Endpoint
/api/access/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the access resource.
```

--------------------------------

### Create a Namespace

Source: https://docs.entropy-data.com/usage-examples

Initializes a new namespace to serve as a container for organizational concepts.

```bash
curl --request PUT https://api.entropy-data.com/api/semantics/experimental/namespaces/main \
--header "x-api-key: $ENTROPY_DATA_API_KEY" \
--header "content-type: application/json" \
--data @- << EOF
{
    "namespace": "main",
    "name": "Main",
    "description": "The default namespace for the organization."
}
EOF
```

--------------------------------

### GET /api/dataproducts/:id

Source: https://docs.entropy-data.com/usage-examples

Retrieves the details of a specific data product.

```APIDOC
## GET /api/dataproducts/:id

### Description
Retrieves the data product definition in the ODPS structure.

### Method
GET

### Endpoint
/api/dataproducts/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the data product.
```

--------------------------------

### Initialize Databricks Asset Bundle

Source: https://docs.entropy-data.com/integrations/databricks

Use the Entropy Data template to create a new Databricks Asset Bundle for data products.

```bash
# Create a new Databricks Asset Bundle using the Entropy Data template
databricks bundle init https://github.com/datamesh-manager/databricks-bundle-python-template
```

--------------------------------

### GET /api/v1/traces

Source: https://docs.entropy-data.com/howto/usage

Retrieves trace data from the Entropy Data API.

```APIDOC
## GET /api/v1/traces

### Description
Retrieves trace data stored in the Entropy Data system.

### Method
GET

### Endpoint
/api/v1/traces
```

--------------------------------

### Configure via .env File

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Define configuration variables in a local .env file for automatic loading.

```text
ENTROPY_DATA_API_KEY=your-api-key
ENTROPY_DATA_HOST=https://app.entropy-data.com
```

--------------------------------

### Check application logs

Source: https://docs.entropy-data.com/installation-docker

Follow the logs of the running containers to monitor startup and application status.

```bash
docker compose logs -f
```

--------------------------------

### Event API response

Source: https://docs.entropy-data.com/events

Example of a successful response containing a list of CloudEvents.

```json
[
{
  "specversion": "1.0",
  "id": "1ee0b7f3-e6a7-60e2-ae80-2788ab757ee0",
  "type": "com.datamesh-manager.events.AccessRequestedEvent",
  "source": "https://app.datamesh-manager.com",
  "time": "2023-06-15T13:19:23.052693Z",
  "subject": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
  "datacontenttype": "application/json",
  "dataschema": "https://api.datamesh-manager.com/api/openapi.yaml#/components/schemas/AccessRequestedEvent",
  "data": {
    "id": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
    "timestamp": "2023-06-15T13:19:23.052636441Z"
  }
},
{
  "specversion": "1.0",
  "id": "1ee0b7f3-e7c9-6953-ae80-2d4755b4bfa9",
  "type": "com.datamesh-manager.events.AccessApprovedEvent",
  "source": "https://app.datamesh-manager.com",
  "time": "2023-06-15T13:19:23.216357Z",
  "subject": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
  "datacontenttype": "application/json",
  "dataschema": "https://api.datamesh-manager.com/api/openapi.yaml#/components/schemas/AccessApprovedEvent",
  "data": {
    "id": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
    "timestamp": "2023-06-15T13:19:23.216330881Z"
  }
},
{
  "specversion": "1.0",
  "id": "1ee0b7f3-e7f0-6a54-ae80-033fc3b099d2",
  "type": "com.datamesh-manager.events.AccessActivatedEvent",
  "source": "https://app.datamesh-manager.com",
  "time": "2023-06-15T13:19:23.232604Z",
  "subject": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
  "datacontenttype": "application/json",
  "dataschema": "https://api.datamesh-manager.com/api/openapi.yaml#/components/schemas/AccessActivatedEvent",
  "data": {
    "id": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
    "timestamp": "2023-06-15T13:19:23.232578049Z"
  }
},
{
  "specversion": "1.0",
  "id": "1ee0ea8d-faaf-6e3f-be02-bd958ebb5a5f",
  "type": "com.datamesh-manager.events.AccessDeactivatedEvent",
  "source": "https://app.datamesh-manager.com",
  "time": "2023-06-19T13:54:56.482679Z",
  "subject": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
  "datacontenttype": "application/json",
  "dataschema": "https://api.datamesh-manager.com/api/openapi.yaml#/components/schemas/AccessDeactivatedEvent",
  "data": {
    "id": "6245dfda-1087-4cb4-9ebf-4b1cc393c3dd",
    "timestamp": "2023-06-19T13:54:56.478285988Z"
  }
}
]
```

```json
[]
```

--------------------------------

### GET /api/datacontracts/:id/datacontract.yaml

Source: https://docs.entropy-data.com/usage-examples

Retrieves the data contract in ODCS YAML format.

```APIDOC
## GET /api/datacontracts/:id/datacontract.yaml

### Description
Returns the specified data contract as an ODCS YAML file.

### Method
GET

### Endpoint
/api/datacontracts/:id/datacontract.yaml
```

--------------------------------

### Troubleshoot Pod Issues

Source: https://docs.entropy-data.com/installation-kubernetes

Inspect pod status and logs to diagnose startup failures.

```bash
kubectl describe pod -n entropy-data <pod-name>
kubectl logs -n entropy-data <pod-name>
```

--------------------------------

### GET /api/datacontracts/:id

Source: https://docs.entropy-data.com/usage-examples

Retrieves the data contract details in JSON format.

```APIDOC
## GET /api/datacontracts/:id

### Description
Returns the specified data contract as a JSON object.

### Method
GET

### Endpoint
/api/datacontracts/:id
```

--------------------------------

### Export and Apply Data for GitOps

Source: https://docs.entropy-data.com/howto/import-export

Perform a two-step promotion by exporting data from a source instance and applying it to a target instance.

```bash
# On (or with access to) the source instance
entropy-data --connection test export dir ./org-state

# Review or commit ./org-state to git, then, against the target
entropy-data --connection prod apply dir ./org-state
```

--------------------------------

### Configure via Environment Variables

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Set authentication and TLS verification settings using shell environment variables.

```bash
export ENTROPY_DATA_API_KEY="your-api-key"
export ENTROPY_DATA_HOST="https://app.entropy-data.com"

# Optional: verify TLS against the OS trust store instead of the bundled CA certificates
export ENTROPY_DATA_SYSTEM_TRUSTSTORE=1
```

--------------------------------

### Postgres Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of extracting server fields from a Postgres qualifiedName string.

```json
{
  "qualifiedName": "postgresql://db.example.com:5432/dbs/mydb/schemas/public/tables/mytable"
}
```

--------------------------------

### PUT /api/example-data/:id

Source: https://docs.entropy-data.com/usage-examples

Attaches sample datasets to data products to allow data consumers to preview data before requesting access.

```APIDOC
## PUT /api/example-data/:id

### Description
Attaches sample datasets to data products. The payload supports tabular data as an array of objects or key-value style data.

### Method
PUT

### Endpoint
/api/example-data/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the example data entry.

#### Request Body
- **id** (string) - Required - The unique identifier for the example data.
- **dataProductId** (string) - Required - The ID of the associated data product.
- **outputPortId** (string) - Required - The ID of the output port.
- **schemaName** (string) - Required - The schema name for the data.
- **data** (array/object) - Required - The sample data to attach (max 1MB).

### Request Example
{
    "id": "customer-cohorts-example",
    "dataProductId": "customer-cohorts",
    "outputPortId": "snowflake-customer-cohorts-v1",
    "schemaName": "customer_cohorts",
    "data": [
        {"CUSTOMER_ID": "CUST-4821", "COHORT_NAME": "high-value"},
        {"CUSTOMER_ID": "CUST-7733", "COHORT_NAME": "churn-risk"}
    ]
}
```

--------------------------------

### Purview Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of extracting server fields from a Purview qualifiedName string.

```json
{
  "qualifiedName": "mssql://sqlserver.example.com:1433/mydb/myschema/mytable"
}
```

--------------------------------

### POST /api/access/{id}/provisioning/{transition}

Source: https://docs.entropy-data.com/concepts/provisioning

Reports a transition in the provisioning state of an access grant. Transitions include provisioning-started, provisioning-succeeded, provisioning-failed, deprovisioning-started, deprovisioning-succeeded, and deprovisioning-failed.

```APIDOC
## POST /api/access/{id}/provisioning/{transition}

### Description
Reports a transition in the provisioning state of an access grant. This allows Entropy Data to track whether the permission behind an access agreement actually exists in the target data platform.

### Method
POST

### Endpoint
/api/access/{id}/provisioning/{transition}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the access.
- **transition** (string) - Required - The specific transition state (e.g., provisioning-succeeded).

### Request Body
- **platform** (string) - Optional - The data platform name.
- **executor** (string) - Optional - The name of the component performing the action.
- **reference** (string) - Optional - Identifier for the grant in the platform.
- **customProperties** (array) - Optional - List of custom property objects.
- **links** (object) - Optional - Map of relevant links.
- **diagnostics** (string) - Optional - Error details if the transition failed.

### Request Example
{
  "platform": "bigquery",
  "executor": "Orders Access Connector",
  "reference": "projects/acme-prod/roles/orders_analytics_reader",
  "customProperties": [
    { "property": "grantId", "value": "g-9f2c41ab" }
  ],
  "links": { "Run log": "https://connector.example.com/runs/8412" }
}
```

--------------------------------

### GET /api/dataproducts

Source: https://docs.entropy-data.com/authentication

Retrieves data products using an authenticated request with an API key.

```APIDOC
## GET /api/dataproducts

### Description
Retrieves a list of data products. This request must be authenticated using an API key provided in the request header.

### Method
GET

### Endpoint
https://api.entropy-data.com/api/dataproducts

### Parameters
#### Request Headers
- **x-api-key** (string) - Required - The secret API key generated from your organization settings.
```

--------------------------------

### Manage Resources via CLI

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Commands for creating or updating teams, approving access agreements, and searching across all resources.

```bash
# Create or update a team from a YAML file
entropy-data teams put marketing --file team.yaml

# Approve an access agreement
entropy-data access approve 640864de-83d4-4619-afba-ccea8037ed3a

# Search across all resources
entropy-data search query "customer orders"
```

--------------------------------

### GET /api/v1/traces

Source: https://docs.entropy-data.com/howto/usage

Retrieves stored usage data traces based on optional filter parameters.

```APIDOC
## GET /api/v1/traces

### Description
Retrieves stored usage data traces. You can filter the results using scope name, data product ID, or data contract ID.

### Method
GET

### Endpoint
https://api.entropy-data.com/api/v1/traces

### Parameters
#### Query Parameters
- **scopeName** (string) - Optional - Filter by scope name (e.g., "usage")
- **dataProductId** (string) - Optional - Filter by data product external ID
- **dataContractId** (string) - Optional - Filter by data contract external ID

### Request Example
curl -X GET "https://api.entropy-data.com/api/v1/traces?scopeName=usage&dataProductId=orders-data-product" -H "X-API-Key: YOUR_API_KEY"
```

--------------------------------

### Initialize Snowflake Connection and Sync

Source: https://docs.entropy-data.com/howto/usage

Establishes a connection to Snowflake and triggers the synchronization process using an Entropy API key.

```python
snowflake_conn = snowflake.connector.connect(
    user='YOUR_USER',
    password='YOUR_PASSWORD',
    account='YOUR_ACCOUNT'
)

sync_snowflake_usage('YOUR_ENTROPY_API_KEY', snowflake_conn)
```

--------------------------------

### Create Kubernetes Namespace

Source: https://docs.entropy-data.com/installation-kubernetes

Initialize a dedicated namespace for the Entropy Data deployment.

```bash
kubectl create namespace entropy-data
```

--------------------------------

### GET /api/access/{id}/provisioning

Source: https://docs.entropy-data.com/concepts/provisioning

Retrieves the current provisioning record for a specific access request.

```APIDOC
## GET /api/access/{id}/provisioning

### Description
Returns the current provisioning record for the specified access ID.

### Method
GET

### Endpoint
/api/access/{id}/provisioning

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the access.
```

--------------------------------

### Preview Sync Changes

Source: https://docs.entropy-data.com/howto/import-export

Perform a dry run to see planned changes without modifying the target instance.

```bash
entropy-data sync --source test --target prod \
  --include teams,policies,datacontracts,dataproducts --dry-run
```

```text
Dry run — planned changes:
  teams: create=13, update=0
  policies: create=9, update=0
  datacontracts: create=24, update=0
  dataproducts: create=28, update=0
```

--------------------------------

### Snowflake Asset Mapping

Source: https://docs.entropy-data.com/concepts/assets

Example of defining server fields for a Snowflake asset using custom properties.

```json
{
  "custom": {
    "account": "myaccount",
    "database": "MYDB",
    "schema": "PUBLIC"
  }
}
```

--------------------------------

### Use system trust store for a single command

Source: https://docs.entropy-data.com/integrations/entropy-data-cli

Pass the --system-truststore flag to verify TLS certificates against the operating system's trust store instead of the bundled Python certificates.

```bash
entropy-data --system-truststore datacontracts list
```

--------------------------------

### Example Array Property Value

Source: https://docs.entropy-data.com/customizations

Array properties are managed as a list of text rows within defined constraints.

```yaml
customProperties:
  - property: "costCenters"
    value:
      - "CC-1000"
      - "CC-2000"
```
Tokens:
Raw