Update

Update modifies mutable metadata on a decoy. The decoy variant is fixed at Create — rotate the secret with Rotate instead.

PATCH /api/v1/decoys/{id}

Typescript (SDK)

TypeScript

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.decoy.update({
    id: "<id>",
  });

  console.log(result);
}

run();

curl --request PATCH \
  --url https://{tenantDomain}.conductor.one/api/v1/decoys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "decoy": {
    "annotations": {},
    "description": "<string>",
    "disabled": true,
    "displayName": "<string>"
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/decoys/{id}"

payload = {
    "decoy": {
        "annotations": {},
        "description": "<string>",
        "disabled": True,
        "displayName": "<string>"
    },
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    decoy: {
      annotations: {},
      description: '<string>',
      disabled: true,
      displayName: '<string>'
    },
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/decoys/{id}', 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://{tenantDomain}.conductor.one/api/v1/decoys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'decoy' => [
        'annotations' => [
                
        ],
        'description' => '<string>',
        'disabled' => true,
        'displayName' => '<string>'
    ],
    'updateMask' => '<string>'
  ]),
  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://{tenantDomain}.conductor.one/api/v1/decoys/{id}"

	payload := strings.NewReader("{\n  \"decoy\": {\n    \"annotations\": {},\n    \"description\": \"<string>\",\n    \"disabled\": true,\n    \"displayName\": \"<string>\"\n  },\n  \"updateMask\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://{tenantDomain}.conductor.one/api/v1/decoys/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"decoy\": {\n    \"annotations\": {},\n    \"description\": \"<string>\",\n    \"disabled\": true,\n    \"displayName\": \"<string>\"\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/decoys/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"decoy\": {\n    \"annotations\": {},\n    \"description\": \"<string>\",\n    \"disabled\": true,\n    \"displayName\": \"<string>\"\n  },\n  \"updateMask\": \"<string>\"\n}"

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

200

{
  "decoy": {
    "annotations": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "disabled": true,
    "displayName": "<string>",
    "id": "<string>",
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "materialFingerprintSha256": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required · read-only

The id field.

Body

application/json

The DecoyServiceUpdateRequest message.

decoy · Decoy · object | null

Decoy is the read projection of a planted honey-credential. All fields except annotations are server-managed.

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The DecoyServiceUpdateResponse message.

decoy · Decoy · object | null

Decoy is the read projection of a planted honey-credential. All fields except annotations are server-managed.

Show child attributes