curl --request POST \
--url http://localhost:8080/api/v1/protect/reveal \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"pipeline": "<string>",
"field": "<string>",
"values": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/api/v1/protect/reveal"
payload = {
"pipeline": "<string>",
"field": "<string>",
"values": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({pipeline: '<string>', field: '<string>', values: ['<string>']})
};
fetch('http://localhost:8080/api/v1/protect/reveal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/protect/reveal",
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([
'pipeline' => '<string>',
'field' => '<string>',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/protect/reveal"
payload := strings.NewReader("{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:8080/api/v1/protect/reveal")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/protect/reveal")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"pipeline": "<string>",
"field": "<string>",
"values": [
"<string>"
],
"revealed": 123,
"failed": 123,
"errors": [
{
"index": 123,
"message": "<string>"
}
]
}Reveal values of an encrypt-protected field
Decrypts enc:v<n>: ciphertexts that a pipeline’s encrypt field protection wrote to a destination. Stateless: send the ciphertexts you read from the destination; Datris never queries a destination. A ciphertext is bound to its pipeline and field, so one copied to another pipeline or column fails. Needs the protect:reveal capability, which no key template or editor/viewer role carries; admins, the full-access template and legacy unscoped keys hold it through *:*. Not available as an MCP tool. Every call is recorded in the audit log as protect / reveal (field name and counts only, never a value), with outcome warning when any value failed; denied calls are recorded as security events.
curl --request POST \
--url http://localhost:8080/api/v1/protect/reveal \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"pipeline": "<string>",
"field": "<string>",
"values": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/api/v1/protect/reveal"
payload = {
"pipeline": "<string>",
"field": "<string>",
"values": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({pipeline: '<string>', field: '<string>', values: ['<string>']})
};
fetch('http://localhost:8080/api/v1/protect/reveal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/protect/reveal",
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([
'pipeline' => '<string>',
'field' => '<string>',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/protect/reveal"
payload := strings.NewReader("{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:8080/api/v1/protect/reveal")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/protect/reveal")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline\": \"<string>\",\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"pipeline": "<string>",
"field": "<string>",
"values": [
"<string>"
],
"revealed": 123,
"failed": 123,
"errors": [
{
"index": 123,
"message": "<string>"
}
]
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Body
Response
One slot per input value, in input order. A value that is not a Datris ciphertext for this pipeline and field (or whose key version no longer exists) yields null in its slot and an entry in errors; the rest are still revealed.
