Update an existing project connection by name.

Performs a full replacement of the connection details. Any fields not included in the update request will be unset.

PUT /v1/projects/{projectId}/connections

Update an existing project connection by name.

cURL

curl --request PUT \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authType": "GENERIC_SECRET",
  "platformConnectionType": "COMPONENT_BASIC",
  "connectionDetails": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    },
    "description": "<string>",
    "secretsLocation": {
      "region": "<string>"
    }
  }
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections"

payload = {
    "authType": "GENERIC_SECRET",
    "platformConnectionType": "COMPONENT_BASIC",
    "connectionDetails": {
        "connectionProperties": { "credentialSecretName": "aws-platform-credentials" },
        "description": "<string>",
        "secretsLocation": { "region": "<string>" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authType: 'GENERIC_SECRET',
    platformConnectionType: 'COMPONENT_BASIC',
    connectionDetails: {
      connectionProperties: {credentialSecretName: 'aws-platform-credentials'},
      description: '<string>',
      secretsLocation: {region: '<string>'}
    }
  })
};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'authType' => 'GENERIC_SECRET',
    'platformConnectionType' => 'COMPONENT_BASIC',
    'connectionDetails' => [
        'connectionProperties' => [
                'credentialSecretName' => 'aws-platform-credentials'
        ],
        'description' => '<string>',
        'secretsLocation' => [
                'region' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections"

	payload := strings.NewReader("{\n  \"authType\": \"GENERIC_SECRET\",\n  \"platformConnectionType\": \"COMPONENT_BASIC\",\n  \"connectionDetails\": {\n    \"connectionProperties\": {\n      \"credentialSecretName\": \"aws-platform-credentials\"\n    },\n    \"description\": \"<string>\",\n    \"secretsLocation\": {\n      \"region\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authType\": \"GENERIC_SECRET\",\n  \"platformConnectionType\": \"COMPONENT_BASIC\",\n  \"connectionDetails\": {\n    \"connectionProperties\": {\n      \"credentialSecretName\": \"aws-platform-credentials\"\n    },\n    \"description\": \"<string>\",\n    \"secretsLocation\": {\n      \"region\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authType\": \"GENERIC_SECRET\",\n  \"platformConnectionType\": \"COMPONENT_BASIC\",\n  \"connectionDetails\": {\n    \"connectionProperties\": {\n      \"credentialSecretName\": \"aws-platform-credentials\"\n    },\n    \"description\": \"<string>\",\n    \"secretsLocation\": {\n      \"region\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "authProvider": "salesforce",
  "authType": "GENERIC_SECRET",
  "connectionDetails": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    },
    "description": "<string>",
    "secretsLocation": {
      "region": "<string>"
    }
  },
  "createdBy": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "name": "my-secret",
  "platformConnectionType": "COMPONENT_BASIC",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "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 · required

The unique identifier of the project containing the connection to update.

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

Query Parameters

connectionName · string · required

The name of the connection to update.

Body

application/json

The update request containing the new connection details.

authType · enum<string> · required

The kind of secret being referenced. See the combinations table in the operation description for valid values per connection type.

Available options: GENERIC_SECRET, CLOUD_PROVIDER_SECRET, OAUTH_USER_TOKENS, OAUTH_AUTHORIZATION_CODE, OAUTH_CLIENT_CRED, COMPOSITE_TOKEN, OAUTH_1_0_X_ADS

Example:

"GENERIC_SECRET"

platformConnectionType · enum<string> · required

The different types of connection that can be created:

• COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
• CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, GCP) using cloud credentials stored in your secrets manager.

Available options: COMPONENT_BASIC, CLOUD_PLATFORM_CREDENTIALS

Example:

"COMPONENT_BASIC"

connectionDetails · object

Provides the definition of the values of the connection which will vary by connection type. Includes:

• Location of any sensitive values (secret location and name)
• Any non-sensitive values (url, username)

Show child attributes

Response

200

application/json

Successfully updated the project connection

authProvider · string

The authentication provider

Example:

"salesforce"

authType · enum<string>

The authentication type

Available options: GENERIC_SECRET, CLOUD_PROVIDER_SECRET, OAUTH_USER_TOKENS, OAUTH_AUTHORIZATION_CODE, OAUTH_CLIENT_CRED, COMPOSITE_TOKEN, OAUTH_1_0_X_ADS

Example:

"GENERIC_SECRET"

connectionDetails · object

Provides the definition of the values of the connection which will vary by connection type. Includes:

• Location of any sensitive values (secret location and name)
• Any non-sensitive values (url, username)

Show child attributes

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-secret"

platformConnectionType · enum<string>

The different types of connection that can be created:

• COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
• CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, GCP) using cloud credentials stored in your secrets manager.

Available options: COMPONENT_BASIC, CLOUD_PLATFORM_CREDENTIALS

Example:

"COMPONENT_BASIC"

projectId · string<uuid>

The project ID this connection belongs to