Create Clone Input

Creates the input archive for a clone fleet operation, which replicates a key store from a source HSM to a target HSM.

POST /key-stores/{storeId}/clone/input

Create Clone Input

cURL

curl --request POST \
  --url https://api.dfns.io/key-stores/{storeId}/clone/input \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "kind": "Clone",
  "hsmSourceSerial": "<string>",
  "hsmTargetSerial": "<string>",
  "macTargetSerial": "<string>"
}
'

import requests

url = "https://api.dfns.io/key-stores/{storeId}/clone/input"

payload = {
    "kind": "Clone",
    "hsmSourceSerial": "<string>",
    "hsmTargetSerial": "<string>",
    "macTargetSerial": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-DFNS-USERACTION": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-DFNS-USERACTION': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    kind: 'Clone',
    hsmSourceSerial: '<string>',
    hsmTargetSerial: '<string>',
    macTargetSerial: '<string>'
  })
};

fetch('https://api.dfns.io/key-stores/{storeId}/clone/input', 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.dfns.io/key-stores/{storeId}/clone/input",
  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([
    'kind' => 'Clone',
    'hsmSourceSerial' => '<string>',
    'hsmTargetSerial' => '<string>',
    'macTargetSerial' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-DFNS-USERACTION: <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 := "https://api.dfns.io/key-stores/{storeId}/clone/input"

	payload := strings.NewReader("{\n  \"kind\": \"Clone\",\n  \"hsmSourceSerial\": \"<string>\",\n  \"hsmTargetSerial\": \"<string>\",\n  \"macTargetSerial\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-DFNS-USERACTION", "<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("https://api.dfns.io/key-stores/{storeId}/clone/input")
  .header("Authorization", "Bearer <token>")
  .header("X-DFNS-USERACTION", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"Clone\",\n  \"hsmSourceSerial\": \"<string>\",\n  \"hsmTargetSerial\": \"<string>\",\n  \"macTargetSerial\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/key-stores/{storeId}/clone/input")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-DFNS-USERACTION"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kind\": \"Clone\",\n  \"hsmSourceSerial\": \"<string>\",\n  \"hsmTargetSerial\": \"<string>\",\n  \"macTargetSerial\": \"<string>\"\n}"

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

200

"<string>"

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

KeyStores:Fleets:Clone: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

X-DFNS-USERACTION · string · header · required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Path Parameters

storeId · string · required

Minimum string length: 1

Body

application/json

kind · enum<string> · required

Available options: Clone

hsmSourceSerial · string · required

Minimum string length: 1

hsmTargetSerial · string · required

Minimum string length: 1

macTargetSerial · string

Minimum string length: 1

Response

200 - application/zip

Success

Zip archive containing input/input.json, the clone fleet-input document.