Skip to main content
POST
/
api
/
v2
/
vault
/
retrieve
Retrieve Data from Locker
curl --request POST \
  --url https://api.example.com/api/v2/vault/retrieve \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_id": "<string>",
  "vault_id": "<string>"
}
'
import requests

url = "https://api.example.com/api/v2/vault/retrieve"

payload = {
    "entity_id": "<string>",
    "vault_id": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({entity_id: '<string>', vault_id: '<string>'})
};

fetch('https://api.example.com/api/v2/vault/retrieve', 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://api.example.com/api/v2/vault/retrieve",
  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([
    'entity_id' => '<string>',
    'vault_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/api/v2/vault/retrieve"

	payload := strings.NewReader("{\n  \"entity_id\": \"<string>\",\n  \"vault_id\": \"<string>\"\n}")

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

	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://api.example.com/api/v2/vault/retrieve")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_id\": \"<string>\",\n  \"vault_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/vault/retrieve")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity_id\": \"<string>\",\n  \"vault_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {}
}

Headers

​
x-tenant-id
string

Body

application/json

The request body might be JWE + JWS encrypted when using middleware

​
entity_id
string

Unique identifier for the entity

​
vault_id
string

Unique identifier for the vault

Response

200 - application/json

Retrieve Data Response

​
data
object