Create a new Secret Value

Creates a new secret value, which is encrypted in transit using the certificate of the provided Agent, then decrypted by the Agent and stored in plain-text within the Customer vault.

POST /v1/secrets/{agentId}/secret-value

Create a new Secret Value

cURL

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/secrets/{agentId}/secret-value \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret": {
    "name": "my-secret",
    "key": "<string>",
    "type": "PASSWORD",
    "value": "<unknown>"
  }
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/secrets/{agentId}/secret-value"

payload = { "secret": {
        "name": "my-secret",
        "key": "<string>",
        "type": "PASSWORD",
        "value": "<unknown>"
    } }
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({
    secret: {name: 'my-secret', key: '<string>', type: 'PASSWORD', value: '<unknown>'}
  })
};

fetch('https://eu1.api.matillion.com/dpc/v1/secrets/{agentId}/secret-value', 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/secrets/{agentId}/secret-value",
  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([
    'secret' => [
        'name' => 'my-secret',
        'key' => '<string>',
        'type' => 'PASSWORD',
        'value' => '<unknown>'
    ]
  ]),
  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/secrets/{agentId}/secret-value"

	payload := strings.NewReader("{\n  \"secret\": {\n    \"name\": \"my-secret\",\n    \"key\": \"<string>\",\n    \"type\": \"PASSWORD\",\n    \"value\": \"<unknown>\"\n  }\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/secrets/{agentId}/secret-value")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"secret\": {\n    \"name\": \"my-secret\",\n    \"key\": \"<string>\",\n    \"type\": \"PASSWORD\",\n    \"value\": \"<unknown>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/secrets/{agentId}/secret-value")

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  \"secret\": {\n    \"name\": \"my-secret\",\n    \"key\": \"<string>\",\n    \"type\": \"PASSWORD\",\n    \"value\": \"<unknown>\"\n  }\n}"

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

201

{
  "resolver_ref": "<string>",
  "vaultSecretName": "<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

agentId · string · required

Query Parameters

projectId · string<uuid>

Body

application/json

secret · object · required

Details of the secret to store in the customer vault.

Show child attributes

Response

201

application/json

Created

resolver_ref · string

vaultSecretName · string