Creates a custom attribute in the platform.
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| status | number | optional | Pass 1 to activate the attribute. Pass 0 to deactivate the attribute. |
| description | string | optional | Pass a description for the attribute within 500 characters. |
| name | string | optional | Pass a name for the attribute within 100 characters. |
| type | number | optional | Pass the number associated with the type. |
| choices | array | optional | Pass the list of choices for a single-select attribute. |
| is_actionable | boolean | optional | Pass true to enable the custom attribute to be modified in threat data objects. |
| sdo_objects | array | optional | Pass the list of SDOs on which you want to list this attribute as actionable. To get the list of supported SDO types, see the Supported SDO Types table in Threat Data > Miscellaneous. |
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.
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.
curl --request POST \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-attribute/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"status": 1,
"description": "location data",
"name": "location",
"type": 3,
"choices": [
"SDO1"
],
"is_actionable": false,
"sdo_objects": [
"indicator"
]
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-attribute/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "POST",
headers: {},
body: JSON.stringify({
"status": 1,
"description": "location data",
"name": "location",
"type": 3,
"choices": [
"SDO1"
],
"is_actionable": false,
"sdo_objects": [
"indicator"
]
}),
});
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.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-attribute/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"status": 1,
"description": "location data",
"name": "location",
"type": 3,
"choices": [
"SDO1"
],
"is_actionable": false,
"sdo_objects": [
"indicator"
]
}
response = requests.request("POST", 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.
{
"status": 1,
"description": "location data",
"name": "location",
"type": 3,
"choices": [
"SDO1"
],
"is_actionable": false,
"sdo_objects": [
"indicator"
]
}View-only example — running live API calls requires a role with snippet testing access.
{
"id": "f63bd86e-441d-4cb8-86d3-9c5e0bdd45d8",
"name": "location",
"type": 3,
"description": "location data",
"ctix_created": 1633107657,
"ctix_modified": 1633107657,
"choices": [
"SDO1"
],
"is_actionable": false,
"status": 1,
"sdo_objects": [
"indicator"
],
"manual": true
}View-only example — running live API calls requires a role with snippet testing access.