Updates the relation SDO in the initiated detailed STIX form submission.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| intel-id | string | optional | Pass the unique ID of the intel submission. |
| relationship-id | string | optional | Pass the relationship ID. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| created_by_ref | object | optional | Pass the list that contains the ID and name of the object being referred. |
| revoked | boolean | optional | Pass true if the object is revoked, else pass false. |
| labels | array | optional | Pass the list that contains the ID and name of the labels attached to the object. |
| custom_properties | array | optional | Pass the list that contains the unique identifier for the custom property, type, name, and the value to add for the same. |
| external_references | object | optional | Pass the list that contains the standard STIX format to send external references. |
| tlp | object | optional | Pass the list that contains the UI label and value of TLP. |
| description | string | optional | Pass the description of the object. |
| relationship_type | string | required | Pass the value that indicates the relation type between the given source and the target. |
| source_ref | object | required | Pass the list that contains source object details in relation, such as |
| target_ref | object | optional | Pass the list that contains target object details in relation, such as |
| start_time | number | optional | Pass the date and time at which the relationship first starts. |
| stop_time | number | optional | Pass the date and time at which the relationship expires. |
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 PUT \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/shareable-intel/{intel-id}/relationship/{relationship-id}/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"external_references": {},
"tlp": {},
"description": "relationship desc",
"relationship_type": "targets",
"source_ref": {},
"target_ref": {},
"start_time": 1630434600,
"stop_time": 1631039400
}'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}/relationship/{relationship-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": [
{}
],
"external_references": {},
"tlp": {},
"description": "relationship desc",
"relationship_type": "targets",
"source_ref": {},
"target_ref": {},
"start_time": 1630434600,
"stop_time": 1631039400
}),
});
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}/relationship/{relationship-id}/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"external_references": {},
"tlp": {},
"description": "relationship desc",
"relationship_type": "targets",
"source_ref": {},
"target_ref": {},
"start_time": 1630434600,
"stop_time": 1631039400
}
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.
{
"created_by_ref": {},
"revoked": false,
"labels": [
{}
],
"custom_properties": [
{}
],
"external_references": {},
"tlp": {},
"description": "relationship desc",
"relationship_type": "targets",
"source_ref": {},
"target_ref": {},
"start_time": 1630434600,
"stop_time": 1631039400
}View-only example — running live API calls requires a role with snippet testing access.
{
"id": "relationship--0178fed4-993f-4d06-9e7e-21de439739a7",
"created_by_ref": {},
"tlp": {},
"revoked": false,
"labels": [
{}
],
"external_references": {},
"custom_properties": [
{}
],
"relationship_type": "targets",
"description": "relationship desc",
"source_ref": {},
"target_ref": {},
"start_time": 1630434600,
"stop_time": 1631039400
}View-only example — running live API calls requires a role with snippet testing access.