Skip to content

Create Projects API Examples

Audience: Data Engineers

Content Summary: This page contains example request payloads for creating projects.

Basic Project

name: A Bare Bones Project
projectKey: simplest possible project

Project: Anyone Can Subscribe

name: Anyone Project
projectKey: Anyone project
documentation: "# Anyone Can See This"
description: "Anyone can join this project"
allowMaskedJoins: false
subscriptionPolicy:
    type: anyone
    automaticSubscription: true
    description: "Auto-subscribe everyone"
tags:
  - Discovered.PHI
purposes:
  - Use Purposes
  - Purpose Hierarchy.Child 2.Grandchild 2

Project: Anyone Who is Approved

name: Approval Project
projectKey: Approval project
description: "Need approval to join this project"
allowMaskedJoins: true
subscriptionPolicy:
    type: approval
    approvals:
      - requiredPermission: GOVERNANCE
        specificApproverRequired: true
      - requiredPermission: ADMIN
        specificApproverRequired: false

Project: Users with Specific Groups or Attributes

name: Entitlement Project
projectKey: entitlement project
description: "Need specific entitlements to join this project"
subscriptionPolicy:
    type: entitlements
    automaticSubscription: false
    allowDiscovery: true
    entitlements:
      operator: any
      groups:
        - Engineers
        - Founders
      attributes:
        - name: Auth1
          value: super secret

Project with Native CDH Workspace

name: CDH Native Project
projectKey: cdh native project
datasources:
  - Impala Medical Records Parquet
  - Impala Nyc Taxi Fare Parquet
  - Impala Nyc Taxi Trip Parquet
workspace:
  type: cloudera
  config:
    clusters: manager.hadoop.test.example.io
    scheme: hdfs
    database: cdh_native
    directory: cdh_native
    hiveConnection:
      ssl: false
      hostname: manager.hadoop.test.example.io
      port: 10000
    impalaConnection:
      ssl: true
      hostname: manager.hadoop.test.example.io
      port: 21050
      userFiles:
      - keyName: TrustedCerts
        content: <file content goes here>
        userFilename: tls-ca-bundle.pem

Project with Native Databricks Workspace

name: Databricks Native Project
projectKey: databricks native project
datasources:
  - Crime Data
  - Databricks Credit Card Transactions
  - Databricks Hipaa Data
purposes:
  - Use Purposes
workspace:
  type: databricks
  config:
    database: native
    directory: native
    workspaceConfigurationName: S3

Project with Native Snowflake Workspace

name: Snowflake Native Project
projectKey: snowflake native project
datasources:
  - Snowflake Case
  - Snowflake Customer
  - Snowflake Web Sales
workspace:
  type: snowflake
  config:
    schema:
      SNOWFLAKE_NATIVE
    warehouses:
      - DEMO_WH
tags:
  - Discovered.PII