Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
connections
/
environment-overrides
curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections/environment-overrides \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environmentName": "PROD",
  "connectionName": "Salesforce",
  "connectionOverrides": {
    "secretsLocation": {
      "type": "AWS_SECRET_MANAGER",
      "region": "us-east-1"
    },
    "connectionProperties": {
      "secretName": "prod-salesforce-credentials",
      "secretKey": "apiKey"
    }
  }
}
'
{
  "name": "Salesforce",
  "platformConnectionType": "COMPONENT_BASIC",
  "authProvider": "NONE",
  "authType": "GENERIC_SECRET",
  "createdBy": "550e8400-e29b-41d4-a716-446655440001",
  "createdDate": "2024-01-15T10:30:00.123Z",
  "projectId": "550e8400-e29b-41d4-a716-446655440002",
  "connectionOverrides": {
    "secretsLocation": {
      "type": "AWS_SECRET_MANAGER",
      "region": "us-east-1"
    },
    "connectionProperties": {
      "secretName": "prod-salesforce-credentials",
      "secretKey": "apiKey"
    }
  }
}

Authorizations

​
Authorization
string
header
required

a valid bearer token

Path Parameters

​
projectId
string
required

The unique identifier of the project containing the connection

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

Body

application/json

Environment connection override request:

Required fields:

  • environmentName: The name of the environment to apply the override in (e.g., "PROD", "dev")
  • connectionName: The name of the connection to override (e.g., "Salesforce")

For COMPONENT_BASIC connections:

  • connectionOverrides.connectionProperties must include secretName and optional secretKey
  • connectionOverrides.secretsLocation is optional and defaults to the vault location configured on the agent

The environment override request containing all necessary details

​
connectionName
string
required

The name of the connection to override

Example:

"Salesforce"

​
environmentName
string
required

The name of the environment to apply the override in

Example:

"PROD"

​
connectionOverrides
object

Connection override configuration

Response

Environment connection override created successfully

​
authProvider
string

The authentication provider

Example:

"NONE"

​
authType
enum<string>

The authentication type

Available options:
GENERIC_SECRET,
CLOUD_PROVIDER_SECRET
Example:

"GENERIC_SECRET"

​
connectionOverrides
object

Connection override configuration

​
createdBy
string

The user who created the connection

​
createdDate
string<date-time>

The date and time when the connection was created

​
name
string

The name of the connection

Example:

"my-jira-connection"

​
platformConnectionType
enum<string>

The platform connection type

Available options:
DWH,
COMPONENT_BASIC,
CLOUD_PLATFORM_CREDENTIALS
Example:

"COMPONENT_BASIC"

​
projectId
string<uuid>

The project ID this connection belongs to