CTIX
Network live
CTIXPUT

Update Tool SDO

Source docs
PUThttps://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/tool/{tool-id}/

Updates the tool SDO in the initiated detailed STIX form submission.

Path Parameters

NameTypeRequiredDescription
intel-idstringoptional

Pass the unique ID of the intel submission.

tool-idstringoptional

Pass the tool ID.

Body Parameters

NameTypeRequiredDescription
created_by_refobjectoptional

Pass the object ID and name of the Identity SDO being referred.

revokedbooleanoptional

Pass true to specify if the SDO is revoked. Else pass false.

labelsarrayoptional

Pass the list of IDs and names of the labels attached to the SDO.

custom_propertiesarrayoptional

Pass the list of unique identifiers for the custom property, type, name, and the value to add.

tlpobjectoptional

Pass the list that contains the UI label and the value of TLP.

namestringrequired

Pass the name of the SDO.

descriptionstringoptional

Pass the description of the SDO.

aliasesarrayoptional

Pass the list of strings that specify the available alias names for the SDO.

tool_typesarrayoptional

Pass the list of UI labels and the value of the tool type.

tool_versionstringoptional

Pass the string value that contains the version identifier associated with the tool.

kill_chain_phasesarrayoptional

Pass the list of STIX standard kill chain names and the phase names for the same.

Run it

Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).

Playground

Request parameters

Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.

CTIXConnect to Intel ExchangeRequired to change data
Credentials required for PUT

Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.

Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.

Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.

Path Parameters
Request body (JSON)Valid JSON
cURL
curl --request PUT \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/tool/{tool-id}/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
  --data '{
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "tool 1",
  "description": "tool desc",
  "aliases": [
    "tool1"
  ],
  "tool_types": [
    {}
  ],
  "tool_version": "1.2.4",
  "kill_chain_phases": [
    {}
  ]
}'

View-only example — running live API calls requires a role with snippet testing access.

JavaScript
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/tool/{tool-id}/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "PUT",
  headers: {},
  body: JSON.stringify({
    "created_by_ref": {},
    "revoked": false,
    "labels": [
      {}
    ],
    "custom_properties": [
      {}
    ],
    "tlp": {},
    "name": "tool 1",
    "description": "tool desc",
    "aliases": [
      "tool1"
    ],
    "tool_types": [
      {}
    ],
    "tool_version": "1.2.4",
    "kill_chain_phases": [
      {}
    ]
  }),
});

const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);

View-only example — running live API calls requires a role with snippet testing access.

Python
import requests

url = "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/tool/{tool-id}/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
payload = {
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "tool 1",
  "description": "tool desc",
  "aliases": [
    "tool1"
  ],
  "tool_types": [
    {}
  ],
  "tool_version": "1.2.4",
  "kill_chain_phases": [
    {}
  ]
}
response = requests.request("PUT", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)

View-only example — running live API calls requires a role with snippet testing access.

Request Body
{
  "created_by_ref": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "tlp": {},
  "name": "tool 1",
  "description": "tool desc",
  "aliases": [
    "tool1"
  ],
  "tool_types": [
    {}
  ],
  "tool_version": "1.2.4",
  "kill_chain_phases": [
    {}
  ]
}

View-only example — running live API calls requires a role with snippet testing access.

Example Response
{
  "created_by_ref": {},
  "tlp": {},
  "revoked": false,
  "labels": [
    {}
  ],
  "custom_properties": [
    {}
  ],
  "name": "tool 1",
  "description": "tool desc",
  "aliases": [
    "tool1"
  ],
  "tool_types": [
    {}
  ],
  "tool_version": "1.2.4",
  "kill_chain_phases": [
    {}
  ],
  "id": "tool--53266f0c-3587-4816-b589-922b81f6f5ce"
}

View-only example — running live API calls requires a role with snippet testing access.