Create a Secret Reference

An endpoint for creating a secret reference

POST /v1/projects/{projectId}/secret-references/{secretReferenceName}

Create a Secret Reference

cURL

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/secret-references/{secretReferenceName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentType": "AWS",
  "secretReferenceType": "PASSWORD",
  "secretName": "aws-secret-name",
  "description": "My secret reference",
  "secretKey": "aws-secret-key"
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/secret-references/{secretReferenceName}"

payload = {
    "agentType": "AWS",
    "secretReferenceType": "PASSWORD",
    "secretName": "aws-secret-name",
    "description": "My secret reference",
    "secretKey": "aws-secret-key"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agentType: 'AWS',
    secretReferenceType: 'PASSWORD',
    secretName: 'aws-secret-name',
    description: 'My secret reference',
    secretKey: 'aws-secret-key'
  })
};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/secret-references/{secretReferenceName}', 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}/secret-references/{secretReferenceName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'agentType' => 'AWS',
    'secretReferenceType' => 'PASSWORD',
    'secretName' => 'aws-secret-name',
    'description' => 'My secret reference',
    'secretKey' => 'aws-secret-key'
  ]),
  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}/secret-references/{secretReferenceName}"

	payload := strings.NewReader("{\n  \"agentType\": \"AWS\",\n  \"secretReferenceType\": \"PASSWORD\",\n  \"secretName\": \"aws-secret-name\",\n  \"description\": \"My secret reference\",\n  \"secretKey\": \"aws-secret-key\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/secret-references/{secretReferenceName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentType\": \"AWS\",\n  \"secretReferenceType\": \"PASSWORD\",\n  \"secretName\": \"aws-secret-name\",\n  \"description\": \"My secret reference\",\n  \"secretKey\": \"aws-secret-key\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agentType\": \"AWS\",\n  \"secretReferenceType\": \"PASSWORD\",\n  \"secretName\": \"aws-secret-name\",\n  \"description\": \"My secret reference\",\n  \"secretKey\": \"aws-secret-key\"\n}"

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

400

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

secretReferenceName · string · required

Pattern: ^[\w()-]{1,128}$

Body

application/json

Option 1

Option 2

Option 3

Secret Reference request body for creating a new secret reference for an AWS Customer hosted project

agentType · enum<string> · required

The type of agent associated with the project the secret reference will be created in

Available options: AWS, Azure, Matillion hosted

Example:

"AWS"

secretReferenceType · enum<string> · required

The type of secret reference

Available options: PASSWORD

Example:

"PASSWORD"

secretName · string · required

The name of the secret within the Cloud Provider

Example:

"aws-secret-name"

description · string

The description of the secret reference

Example:

"My secret reference"

secretKey · string

The key of the secret within the Cloud Provider

Example:

"aws-secret-key"

Response

201

Created