Create a new environment - Maia Documentation

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "development-env",
  "displayName": "An environment for testing new features",
  "description": "An optional description",
  "defaultAgentId": "0a9f9866-24e6-43ab-8f3c-71089f407241",
  "defaultUserAccessLevel": "admin",
  "defaultConnections": {
    "DWH": {
      "bigquery": "my-dwh-connection"
    },
    "CLOUD_PLATFORM": {
      "gcp": "my-gcp-connection"
    }
  },
  "connectionOverrides": [
    {
      "connectionName": "my-dwh-connection",
      "connectionProperties": {
        "gcpProjectId": {
          "value": "my-gcp-project"
        },
        "defaultDataset": {
          "value": "my_dataset"
        }
      }
    },
    {
      "connectionName": "my-gcp-connection",
      "connectionProperties": {
        "credentialSecretName": "gcp-platform-credentials"
      }
    }
  ]
}
'

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

POST

projects

{projectId}

environments

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "development-env",
  "displayName": "An environment for testing new features",
  "description": "An optional description",
  "defaultAgentId": "0a9f9866-24e6-43ab-8f3c-71089f407241",
  "defaultUserAccessLevel": "admin",
  "defaultConnections": {
    "DWH": {
      "bigquery": "my-dwh-connection"
    },
    "CLOUD_PLATFORM": {
      "gcp": "my-gcp-connection"
    }
  },
  "connectionOverrides": [
    {
      "connectionName": "my-dwh-connection",
      "connectionProperties": {
        "gcpProjectId": {
          "value": "my-gcp-project"
        },
        "defaultDataset": {
          "value": "my_dataset"
        }
      }
    },
    {
      "connectionName": "my-gcp-connection",
      "connectionProperties": {
        "credentialSecretName": "gcp-platform-credentials"
      }
    }
  ]
}
'

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

a valid bearer token

Path Parameters

projectId

string<uuid>

required

Body

application/json

connectionOverrides

object[]

required

Connection overrides for the environment. Each entry overrides the properties of a named connection for this environment. See the request examples for complete per-platform payloads.

Required array length: 1 - 200 elements

Show child attributes

defaultAgentId

string

required

The UUID of the default runner for this environment. The ID must be supplied in lowercase

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

defaultConnections

object

required

The default connections for the new environment. Keys are connection types: DWH maps a warehouse provider (for example snowflake, redshift, databricks, bigquery) to the name of a connection defined in the project, and CLOUD_PLATFORM maps a cloud provider (for example aws, gcp, azure) to a connection name. See the request examples for complete payloads.

Show child attributes

Example:

{
  "DWH": { "snowflake": "my-dwh-connection" }
}

defaultUserAccessLevel

string

required

The default role project users will have on the environment

Examples:

"default"

"admin"

"runner"

"readOnly"

"noAccess"

name

string

required

The name of the new environment

Minimum string length: 1

Example:

"Environment-1"

description

string

The description of the new environment

Maximum string length: 1000

Example:

"My new Environment"

displayName

string

The display name of the new environment

Maximum string length: 255

Example:

"Environment 1"

inheritProjectDefaults

boolean

Determines whether the environment inherits the project's default settings

Response

Environment configuration remains unchanged since last update