Skip to main content
GET
/
projects
/
{projectName}
{
  "resource": "<string>",
  "name": "<string>",
  "readme": "<string>",
  "location": "<string>",
  "connections": [
    {
      "resource": "<string>",
      "name": "<string>",
      "type": "postgres",
      "attributes": {
        "dialectName": "<string>",
        "isPool": true,
        "canPersist": true,
        "canStream": true
      },
      "postgresConnection": {
        "host": "<string>",
        "port": 123,
        "databaseName": "<string>",
        "userName": "<string>",
        "password": "<string>",
        "connectionString": "<string>"
      },
      "bigqueryConnection": {
        "defaultProjectId": "<string>",
        "billingProjectId": "<string>",
        "location": "<string>",
        "serviceAccountKeyJson": "<string>",
        "maximumBytesBilled": "<string>",
        "queryTimeoutMilliseconds": "<string>"
      },
      "snowflakeConnection": {
        "account": "<string>",
        "username": "<string>",
        "password": "<string>",
        "warehouse": "<string>",
        "database": "<string>",
        "schema": "<string>",
        "responseTimeoutMilliseconds": 123
      },
      "trinoConnection": {
        "server": "<string>",
        "port": 123,
        "catalog": "<string>",
        "schema": "<string>",
        "user": "<string>",
        "password": "<string>"
      },
      "mysqlConnection": {
        "host": "<string>",
        "port": 123,
        "database": "<string>",
        "user": "<string>",
        "password": "<string>"
      }
    }
  ],
  "packages": [
    {
      "resource": "<string>",
      "name": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}

Path Parameters

projectName
string
required

Name of the project

Query Parameters

reload
boolean

Load / reload the project before returning result

Response

Project details and metadata

Represents a Malloy project containing packages, connections, and other resources

resource
string

Resource path to the project

name
string

Project name

readme
string

Project README content

location
string

Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)

connections
object[]

List of database connections configured for this project

packages
object[]

List of Malloy packages in this project

I