Adds the campaign SDO to the initiated detailed submission.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| intel-id | string | optional | Pass the unique ID of the intel submission. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| created_by_ref | object | optional | Pass the object ID and name of the Identity SDO being referred. |
| revoked | boolean | optional | Pass true if the SDO object is revoked, else pass false. |
| labels | array | optional | Pass the list that contains the ID and name of the labels attached to the SDO. |
| custom_properties | array | optional | Pass the list that contains the unique identifier for the custom property, type, name, and the value user wishes to add for the same. |
| tlp | object | optional | Pass the list that contains the UI label and value of TLP. |
| name | string | required | Pass the name of the SDO. |
| description | string | optional | Pass the description of the SDO. |
| aliases | array | optional | Pass the list of strings that specify the also-known names for the SDO. |
| first_seen | number | optional | Pass the date and time at which the object was first seen. |
| last_seen | number | optional | Pass the date and time at which the object was last seen. |
| objective | string | optional | Pass the objective of the campaign object. |
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/shareable-intel/{intel-id}/campaign/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"tlp": {},
"name": "camp 1",
"description": "camp desc",
"aliases": [
"c1"
],
"first_seen": 1630434600,
"last_seen": 1631039400,
"objective": "campaign objective"
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/campaign/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "POST",
headers: {},
body: JSON.stringify({
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"tlp": {},
"name": "camp 1",
"description": "camp desc",
"aliases": [
"c1"
],
"first_seen": 1630434600,
"last_seen": 1631039400,
"objective": "campaign objective"
}),
});
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/shareable-intel/{intel-id}/campaign/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"tlp": {},
"name": "camp 1",
"description": "camp desc",
"aliases": [
"c1"
],
"first_seen": 1630434600,
"last_seen": 1631039400,
"objective": "campaign objective"
}
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.
{
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"tlp": {},
"name": "camp 1",
"description": "camp desc",
"aliases": [
"c1"
],
"first_seen": 1630434600,
"last_seen": 1631039400,
"objective": "campaign objective"
}View-only example — running live API calls requires a role with snippet testing access.
{
"created_by_ref": {},
"tlp": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"name": "camp 1",
"description": "camp desc",
"aliases": [
"c1"
],
"first_seen": 1630434600,
"last_seen": 1631039400,
"objective": "campaign objective",
"id": "campaign--3d02bbfc-bc5a-4e00-b711-f3c3c303b6e2"
}View-only example — running live API calls requires a role with snippet testing access.