> ## Documentation Index > Fetch the complete documentation index at: https://docs.credibledata.com/llms.txt > Use this file to discover all available pages before exploring further. # List all available projects > Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information. ## OpenAPI ````yaml /dataplane-public-api-doc.yaml get /projects openapi: 3.1.0 info: title: Malloy Publisher - Semantic Model Serving API description: > The Malloy Publisher - Semantic Model Serving API provides comprehensive access to Malloy packages and their associated resources. A Malloy package is a directory containing Malloy models (.malloy files), Malloy notebooks (.malloynb files), and embedded databases (.parquet files) with a malloy-publisher.json manifest at the package's root directory. ## Key Features - **Project Management**: Create and manage projects with their associated packages and connections - **Package Lifecycle**: Full CRUD operations for Malloy packages and their versions - **Model & Notebook Access**: Retrieve and execute Malloy models and notebooks - **Connection Management**: Secure database connection configuration and testing - **Query Execution**: Execute queries against models and retrieve results - **Watch Mode**: Real-time file watching for development workflows ## Resource Hierarchy The API follows a hierarchical resource structure: ``` Projects ├── Connections └── Packages ├── Models ├── Notebooks └── Databases ``` For examples, see the Malloy samples packages (https://github.com/malloydata/malloy-samples) repository. version: v0 servers: - url: https://{organization}.data.credibledata.com/api/v0/ description: Production API server variables: organization: default: demo description: Your organization subdomain security: - bearerAuth: [] tags: - name: publisher description: Publisher status and health check operations - name: projects description: >- Project lifecycle management including creation, configuration, and deletion of data modeling projects - name: connections description: >- Database connection management for secure data source configuration and access - name: packages description: >- Package management for Malloy data models, including versioning and distribution - name: models description: Malloy model access and compilation operations - name: notebooks description: Malloy notebook access and execution operations - name: databases description: Embedded database management and access - name: watch-mode description: Real-time file watching for development workflows paths: /projects: get: tags: - projects summary: List all available projects description: > Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information. operationId: list-projects responses: '200': description: A list of all available projects content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' components: schemas: Project: type: object description: >- Represents a Malloy project containing packages, connections, and other resources properties: resource: type: string description: Resource path to the project name: type: string description: Project name readme: type: string description: Project README content location: type: string description: >- Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.) connections: type: array description: List of database connections configured for this project items: $ref: '#/components/schemas/Connection' packages: type: array description: List of Malloy packages in this project items: $ref: '#/components/schemas/Package' Connection: type: object description: Database connection configuration and metadata properties: resource: type: string description: Resource path to the connection name: type: string description: Name of the connection type: type: string description: Type of database connection enum: - postgres - bigquery - snowflake - trino - mysql - duckdb - motherduck - ducklake attributes: $ref: '#/components/schemas/ConnectionAttributes' postgresConnection: $ref: '#/components/schemas/PostgresConnection' bigqueryConnection: $ref: '#/components/schemas/BigqueryConnection' snowflakeConnection: $ref: '#/components/schemas/SnowflakeConnection' trinoConnection: $ref: '#/components/schemas/TrinoConnection' mysqlConnection: $ref: '#/components/schemas/MysqlConnection' duckdbConnection: $ref: '#/components/schemas/DuckdbConnection' motherduckConnection: $ref: '#/components/schemas/MotherDuckConnection' ducklakeConnection: $ref: '#/components/schemas/DucklakeConnection' Package: type: object description: >- Represents a Malloy package containing models, notebooks, and embedded databases properties: resource: type: string description: Resource path to the package name: type: string description: Package name description: type: string description: Package description location: type: string description: >- Package location, can be an absolute path or URI (e.g. github, s3, gcs, etc.) Error: type: object description: Standard error response format properties: message: type: string description: Human-readable error message describing what went wrong details: type: string description: Additional error details or context required: - message ConnectionAttributes: type: object description: Connection capabilities and configuration attributes properties: dialectName: type: string description: SQL dialect name for the connection isPool: type: boolean description: Whether the connection uses connection pooling canPersist: type: boolean description: Whether the connection supports persistent storage operations canStream: type: boolean description: Whether the connection supports streaming query results PostgresConnection: type: object description: PostgreSQL database connection configuration properties: host: type: string description: PostgreSQL server hostname or IP address port: type: integer description: PostgreSQL server port number databaseName: type: string description: Name of the PostgreSQL database userName: type: string description: PostgreSQL username for authentication password: type: string description: PostgreSQL password for authentication connectionString: type: string description: >- Complete PostgreSQL connection string (alternative to individual parameters) BigqueryConnection: type: object description: Google BigQuery database connection configuration properties: defaultProjectId: type: string description: Default BigQuery project ID for queries billingProjectId: type: string description: BigQuery project ID for billing purposes location: type: string description: BigQuery dataset location/region serviceAccountKeyJson: type: string description: JSON string containing Google Cloud service account credentials maximumBytesBilled: type: string description: Maximum bytes to bill for query execution (prevents runaway costs) queryTimeoutMilliseconds: type: string description: Query timeout in milliseconds SnowflakeConnection: type: object description: Snowflake database connection configuration properties: account: type: string description: Snowflake account identifier username: type: string description: Snowflake username for authentication password: type: string description: Snowflake password for authentication privateKey: type: string description: Snowflake private key for authentication privateKeyPass: type: string description: Passphrase for the Snowflake private key warehouse: type: string description: Snowflake warehouse name database: type: string description: Snowflake database name schema: type: string description: Snowflake schema name role: type: string description: Snowflake role name responseTimeoutMilliseconds: type: integer description: Query response timeout in milliseconds TrinoConnection: type: object description: Trino database connection configuration properties: server: type: string description: Trino server hostname or IP address port: type: number description: Trino server port number catalog: type: string description: Trino catalog name schema: type: string description: Trino schema name user: type: string description: Trino username for authentication password: type: string description: Trino password for authentication peakaKey: type: string description: Peaka API key for authentication with Peaka-hosted Trino clusters MysqlConnection: type: object description: MySQL database connection configuration properties: host: type: string description: MySQL server hostname or IP address port: type: integer description: MySQL server port number database: type: string description: Name of the MySQL database user: type: string description: MySQL username for authentication password: type: string description: MySQL password for authentication DuckdbConnection: type: object description: DuckDB database connection configuration properties: attachedDatabases: type: array items: $ref: '#/components/schemas/AttachedDatabase' MotherDuckConnection: type: object description: MotherDuck database connection configuration properties: accessToken: type: string description: MotherDuck access token database: type: string description: MotherDuck database name DucklakeConnection: type: object description: DuckLake lakehouse connection configuration properties: storage: type: object description: Data storage connection configuration (S3 or GCS) properties: bucketUrl: type: string description: >- URL of the storage bucket (e.g. s3://my-bucket/path or gs://my-bucket/path) s3Connection: $ref: '#/components/schemas/S3Connection' description: AWS S3 connection configuration for data storage gcsConnection: $ref: '#/components/schemas/GCSConnection' description: Google Cloud Storage connection configuration for data storage required: - bucketUrl catalog: type: object description: Catalog metadata connection configuration properties: postgresConnection: $ref: '#/components/schemas/PostgresConnection' description: PostgreSQL connection for DuckLake metadata catalog required: - postgresConnection required: - storage - catalog AttachedDatabase: type: object description: Attached DuckDB database properties: name: type: string pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ example: test_connection, _connection, test_connection_1 type: type: string description: Type of database connection enum: - bigquery - snowflake - postgres - gcs - s3 - azure attributes: $ref: '#/components/schemas/ConnectionAttributes' bigqueryConnection: $ref: '#/components/schemas/BigqueryConnection' snowflakeConnection: $ref: '#/components/schemas/SnowflakeConnection' postgresConnection: $ref: '#/components/schemas/PostgresConnection' gcsConnection: $ref: '#/components/schemas/GCSConnection' s3Connection: $ref: '#/components/schemas/S3Connection' azureConnection: $ref: '#/components/schemas/AzureConnection' S3Connection: type: object description: AWS S3 connection configuration for DuckDB properties: accessKeyId: type: string description: AWS access key ID secretAccessKey: type: string description: AWS secret access key region: type: string description: AWS region (e.g., us-east-1) default: us-east-1 endpoint: type: string description: Custom S3-compatible endpoint URL (optional, for MinIO, etc.) sessionToken: type: string description: AWS session token for temporary credentials (optional) required: - accessKeyId - secretAccessKey GCSConnection: type: object description: Google Cloud Storage connection configuration for DuckDB properties: keyId: type: string description: GCS HMAC access key ID secret: type: string description: GCS HMAC secret key required: - keyId - secret AzureConnection: type: object description: > Azure Data Lake Storage (ADLS Gen2) / Blob Storage connection configuration Supports https://, http://, abfss://, and az:// URL schemes. properties: authType: type: string enum: - service_principal - sas_token description: Authentication method for Azure Storage sasUrl: type: string description: > Full SAS URL including token; required for sas_token auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/*.parquet?sp=rl&st=... tenantId: type: string description: Azure AD tenant ID (required for service_principal) clientId: type: string description: Azure AD application (client) ID (required for service_principal) clientSecret: type: string description: Azure AD client secret (required for service_principal) accountName: type: string description: Azure Storage account name (required for service_principal) fileUrl: type: string description: > Azure file URL to query; required for service_principal auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/** required: - authType responses: Unauthorized: description: Unauthorized - authentication required content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: The server encountered an internal error content: application/json: schema: $ref: '#/components/schemas/Error' ServiceUnavailable: description: >- The service is temporarily unavailable, typically due to initialization, or draining state (Rolling updates, etc.) content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````