Skip to main content

OpenCTI

This Integration is part of the OpenCTI Pack.#

Manages indicators from OpenCTI.
This integration was tested with version 5.12.17 of OpenCTI.

Configure OpenCTI on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for OpenCTI.

  3. Click Add instance to create and configure a new integration instance.

    ParameterRequired
    Base URLTrue
    API Key (leave empty. Fill in the API key in the password field.)False
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

opencti-get-indicators#


Get indicators in OpenCTI.

Base Command#

opencti-get-indicators

Input#

Argument NameDescriptionRequired
searchThe indicator's value to filter by, can be partial value.Optional
created_byThe ID of the entity that created the indicator (use opencti-organization-list to find or create).Optional
creatorThe ID of the indicator creator.Optional
created_afterCreated after date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
created_beforeCreated before date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_until_afterValid until after date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_until_beforeValid until before date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_from_afterValid from after date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_from_beforeValid from before date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
indicator_typesThe types of the indicator. Use opencti-indicator-types-list to find all indicator types in OpenCTI.Optional
label_idThe label ID for the indicator (use opencti-label-list to find or create).Optional
limitThe maximum number of indicators to return. Maximum value is 500. Default is 50.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.Indicators.LastRunID context path.Optional
all_resultsWhen the argument is set to true, the limit argument is ignored. Default is false. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
OpenCTI.Indicators.IndicatorList.idstringUnique ID of the indicator.
OpenCTI.Indicators.IndicatorList.namestringName of the indicator.
OpenCTI.Indicators.IndicatorList.descriptionstringDescription of the indicator.
OpenCTI.Indicators.IndicatorList.patternstringThe pattern associated with the indicator.
OpenCTI.Indicators.IndicatorList.validFromstringThe valid-from date of the indicator.
OpenCTI.Indicators.IndicatorList.validUntilstringThe valid-until date of the indicator.
OpenCTI.Indicators.IndicatorList.scorenumberScore of the indicator.
OpenCTI.Indicators.IndicatorList.confidencenumberConfidence of the indicator.
OpenCTI.Indicators.IndicatorList.createdBystringName of the entity that created the indicator.
OpenCTI.Indicators.IndicatorList.creatorslistName of the indicator creators.
OpenCTI.Indicators.IndicatorList.labelslistLabels associated with the indicator.
OpenCTI.Indicators.IndicatorList.indicatorTypeslistTypes of the indicator.
OpenCTI.Indicators.IndicatorList.createdstringCreation date of the indicator.
OpenCTI.Indicators.IndicatorList.updatedAtstringLast update date of the indicator.
OpenCTI.Indicators.LastRunIDstringThe last ID of the previous fetch for pagination.

opencti-indicator-delete#


Delete indicator.

Base Command#

opencti-indicator-delete

Input#

Argument NameDescriptionRequired
idIndicator ID.Required

Context Output#

There is no context output for this command.

Command Example#

!opencti-indicator-delete id=74faf2e8-bbab-4a1a-a548-58db202c5e57

Human Readable Output#

Indicator deleted.

opencti-indicator-field-update#


Update the indicator field. The fields that can be updated are: score, description.

Base Command#

opencti-indicator-field-update

Input#

Argument NameDescriptionRequired
idIndicator ID.Required
fieldIndicator field to update. Possible values are: score, description.Required
valueValue of the field to update.Required

Context Output#

PathTypeDescription
OpenCTI.Indicator.idStringUpdated indicator ID.

Command Example#

!opencti-indicator-field-update field=score id=81d63245-9ba3-495d-8e78-03b037d71e01 value=100

Context Example#

{
"OpenCTI": {
"Indicator": {
"id": "81d63245-9ba3-495d-8e78-03b037d71e01"
}
}
}

Human Readable Output#

Indicator 81d63245-9ba3-495d-8e78-03b037d71e01 updated successfully.

opencti-indicator-create#


Create new indicator.

Base Command#

opencti-indicator-create

Input#

Argument NameDescriptionRequired
typeThe indicator type to create. Out-of-the-box indicator types supported in XSOAR are: Account, Domain, Email, File-MD5, File-SHA1, File-SHA256, Host, IP, IPV6, Registry Key, and URL. Possible values are: Account, Domain, Email, File-MD5, File-SHA1, File-SHA256, Host, IP, IPv6, Registry Key, URL.Required
created_byOrganization ID. Use opencti-organization-list to find all organization IDs in OpenCTI, or use opencti-organization-create to create a new organization ID.Optional
marking_idIndicator marking definition ID. Use opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Optional
label_idIndicator label ID. Use opencti-label-list to find all label IDs in OpenCTI, or use opencti-label-create to create a new label.Optional
external_references_idExternal references URL. Use opencti-external-reference-create to create a new external reference.Optional
descriptionIndicator description.Optional
scoreIndicator score. Values range is 0 - 100. Default value is 50.Optional
valueIndicator value.Optional

Context Output#

PathTypeDescription
OpenCTI.Indicator.idStringNew indicator ID.

Command Example#

!opencti-indicator-create type=Domain created_by=0c7cb378-64c3-4809-b423-986ac7cecf91 description=test value="TestDomainDocs.com" score=70 label_id=fa57f98e-f2f5-45fd-97f2-bf2c53119044 marking_id=9128e411-c759-4af0-aeb0-b65f12082648

Context Example#

{
"OpenCTI": {
"Indicator": {
"id": "7ed5946a-81a2-4490-8be8-06d3633a41fb",
"type": "Domain",
"value": "TestDomainDocs.com"
}
}
}

Human Readable Output#

Indicator created successfully. New Indicator id: 7ed5946a-81a2-4490-8be8-06d3633a41fb

opencti-indicator-field-add#


Add a field to the indicator. Fields that can be added are marking definition and label.

Base Command#

opencti-indicator-field-add

Input#

Argument NameDescriptionRequired
idIndicator ID.Required
fieldIndicator field to add. Possible values are: marking, label.Required
valueValue of the field to add. Enter label ID or marking definition ID. Use opencti-label-list to find all label IDs in OpenCTI, or use opencti-label-create to create a new label. Use opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Required

Context Output#

There is no context output for this command.

Command Example#

!opencti-indicator-field-add id=33bd535b-fa1c-41e2-a6f9-80d82dd29a9b field=label value=07cfae2d-6cc9-42c5-9fd0-32eff8142404

Human Readable Output#

Added label successfully.

opencti-indicator-field-remove#


Remove indicator field value. Fields which values can be removed are marking definition and label.

Base Command#

opencti-indicator-field-remove

Input#

Argument NameDescriptionRequired
idIndicator ID.Required
fieldIndicator field to update. Possible values are: marking, label.Required
valueValue of the field to remove. Enter label ID or marking definition ID. Use opencti-label-list to find all label IDs in OpenCTI or opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Required

opencti-indicator-create#


Create a new indicator in OpenCTI.

Base Command#

opencti-indicator-create

Input#

Argument NameDescriptionRequired
nameName of the indicator.Required
indicatorValue of the indicator.Required
main_observable_typeMain observable type for the indicator. Possible values are: Account, Domain, Email, File-MD5, File-SHA1, File-SHA256, IP, IPv6, Registry Key, URL.Required
indicator_typesThe types of the indicator. Use opencti-indicator-types-list to find all indicator types in OpenCTI.Optional
descriptionThe description of the indicator.Optional
confidenceConfidence level for the indicator, value between 0 and 100. Default is 50.Optional
scoreThe score of the indicator, value between 0 and 100. Default is 50.Optional
valid_fromThe valid-from date for the indicator in the format YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_untilThe valid-until date for the indicator in the format YYYY-MM-DDThh:mm:ss.sssZ.Optional
created_byThe ID of the entity that created the indicator (use opencti-organization-list to find or create).Optional
label_idThe label ID for the indicator (use opencti-label-list to find or create).Optional
marking_idThe marking ID for the indicator (use opencti-marking-definition-list to find).Optional
external_references_idExternal references ID for the indicator (use opencti-external-reference-create to create).Optional
create_observablesCreate OpenCTI observable related with the OpenCTI indicator created. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
OpenCTI.Indicator.idstringNew Indicator ID.
},
{
"id": "11ddff08-8933-46d7-ab22-31f49496499f",
"name": "ExampleOrganization"
}
]
},
{
"organizationsLastRun": "YXJyYXljb25uZWN0aW9uOjI="
}
]
}

}

#### Human Readable Output
>### Organizations
>|Name|Id|
>|---|---|
>| Test_Organization | 1e12fe87-db3e-4838-8391-6910547bf60d |
>| ExampleOrganization | 11ddff08-8933-46d7-ab22-31f49496499f |
### opencti-organization-create
***
Create a new organization.
#### Base Command
`opencti-organization-create`
#### Input
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| name | Name of the organization to create. | Required |
| description | Description of the organization. | Optional |
| reliability | Reliability of the organization. Possible values are: A, B, C, D, E, F. | Optional |
#### Context Output
| **Path** | **Type** | **Description** |
| --- | --- | --- |
| OpenCTI.Organization.id | String | New organization ID. |
#### Command Example
```!opencti-organization-create name=ExampleOrganization description="create organization" reliability="C"```
#### Context Example
```json
{
"OpenCTI": {
"Organization": {
"id": "11ddff08-8933-46d7-ab22-31f49496499f"
}
}
}

Human Readable Output#

Organization ExampleOrganization was created successfully with id: 11ddff08-8933-46d7-ab22-31f49496499f.

opencti-label-list#


Get list of all labels.

Base Command#

opencti-label-list

Input#

Argument NameDescriptionRequired
limitThe maximum number of labels to return per fetch. Default is 50.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.Labels.labelsLastRun context path.Optional

Context Output#

PathTypeDescription
OpenCTI.Labels.LabelsList.idStringLabel ID.
OpenCTI.Labels.LabelsList.valueStringLabel name.
OpenCTI.Labels.labelsLastRunStringThe last ID of the previous fetch to use for pagination.

Command Example#

!opencti-label-list limit=2

Context Example#

{
"OpenCTI": {
"Labels": {
"LabelsList": [
{
"id": "7ba41668-1594-4a09-9be5-3640f2c2d253",
"value": "demisto_lablel"
},
{
"id": "fa57f98e-f2f5-45fd-97f2-bf2c53119044",
"value": "devdemisto"
}
],
"labelsLastRun": "YXJyYXljb25uZWN0aW9uOjI="
}
}
}

Human Readable Output#

Labels#

ValueId
demisto_lablel7ba41668-1594-4a09-9be5-3640f2c2d253
devdemistofa57f98e-f2f5-45fd-97f2-bf2c53119044

opencti-label-create#


Create a new label.

Base Command#

opencti-label-create

Input#

Argument NameDescriptionRequired
nameName of the new label to create.Required

Context Output#

PathTypeDescription
OpenCTI.Label.idStringNew label ID.

Command Example#

!opencti-label-create name=docsTest

Context Example#

{
"OpenCTI": {
"Label": {
"id": "beb5159a-e162-4352-b7d7-6e355db7f057"
}
}
}

Human Readable Output#

Label docsTest was created successfully with id: beb5159a-e162-4352-b7d7-6e355db7f057.

opencti-external-reference-create#


Create external reference.

Base Command#

opencti-external-reference-create

Input#

Argument NameDescriptionRequired
urlExternal references URL.Required
source_nameExternal references source name.Required

Context Output#

PathTypeDescription
OpenCTI.externalReference.idStringNew external reference ID.

Command Example#

!opencti-external-reference-create source_name=source_name url=www.url.com

Context Example#

{
"OpenCTI": {
"externalReference": {
"id": "8339d023-ada2-4b32-8a29-0a3897fc096d"
}
}
}

Human Readable Output#

Reference source_name was created successfully with id: 8339d023-ada2-4b32-8a29-0a3897fc096d.

opencti-marking-definition-list#


Get a list of all marking definitions.

Base Command#

opencti-marking-definition-list

Input#

Argument NameDescriptionRequired
limitThe maximum number of marking definitions to return per fetch. Default is 50.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.MarkingDefinitions.markingsLastRun context path.Optional

Context Output#

PathTypeDescription
OpenCTI.MarkingDefinitions.MarkingDefinitionsList.idStringMarking definition ID.
OpenCTI.MarkingDefinitions.MarkingDefinitionsList.valueStringMarking definition name.
OpenCTI.MarkingDefinitions.markingsLastRunStringThe last ID of the previous fetch to use for pagination.

Command Example#

!opencti-marking-definition-list limit=2

Context Example#

{
"OpenCTI": {
"MarkingDefinitions": {
"MarkingDefinitionsList": [
{
"id": "dc911977-796a-4d96-95e4-615bd1c41263",
"value": "TLP:GREEN"
},
{
"id": "9128e411-c759-4af0-aeb0-b65f12082648",
"value": "TLP:AMBER"
}
],
"markingsLastRun": "YXJyYXljb25uZWN0aW9uOjI="
}
}
}

Human Readable Output#

Markings#

ValueId
TLP:GREENdc911977-796a-4d96-95e4-615bd1c41263
TLP:AMBER9128e411-c759-4af0-aeb0-b65f12082648

opencti-relationship-create#


Create new relationship.

Base Command#

opencti-relationship-create

Input#

Argument NameDescriptionRequired
from_idSource entity ID for the relationship.Required
to_idTarget entity ID for the relationship.Required
relationship_typeType of relationship to create. Possible values are: uses, targets, indicates, mitigates, attributed-to, located-at, related-to, derived-from, member-of, variant-of, part-of, communicates-with, compromises, delivers, owns, authored-by, impersonates, controls, hosts, investigates. Default is related-to.Optional
descriptionDescription of the relationship.Optional
confidenceConfidence Number. Values range is 0 - 100.Optional

Context Output#

PathTypeDescription
OpenCTI.Relationship.idunknownNew Relationship ID.
OpenCTI.Relationship.relationshipTypeunknownNew Relationship Type.

opencti-incident-delete#


Delete incident.

Base Command#

opencti-incident-delete

Input#

Argument NameDescriptionRequired
idIncident ID.Required

Context Output#

There is no context output for this command.

opencti-incident-create#


Create new incident.

Base Command#

opencti-incident-create

Input#

Argument NameDescriptionRequired
nameIncident name.Required
incident_typeIncident Type name. Use opencti-incident-types-list to find all incident types in OpenCTI.Optional
confidenceIncident Confidence Number. Values range is 0 - 100. Default value is 50.Optional
severityIncident severity. Possible values are: low, medium, high, critical.Optional
descriptionIncident description.Optional
sourceIncident Source.Optional
objectiveIncident objective.Optional
created_byOrganization ID. Use opencti-organization-list to find all organization IDs in OpenCTI, or use opencti-organization-create to create a new organization ID.Optional
first_seenIncident First seen. YYYY-MM-DDThh:mm:ss.sssZ.Optional
last_seenIncident Last seen. YYYY-MM-DDThh:mm:ss.sssZ.Optional
label_idIncident label ID. Use opencti-label-list to find all label IDs in OpenCTI, or use opencti-label-create to create a new label.Optional
marking_idObservable marking definition ID. Use opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Optional
external_references_idExternal references URL. Use opencti-external-reference-create to create a new external reference.Optional

Context Output#

PathTypeDescription
OpenCTI.Incident.idStringNew Incident ID.

opencti-observable-field-add#


Add a field to the observable. Fields that can be added are marking definition and label.

Base Command#

opencti-observable-field-add

Input#

Argument NameDescriptionRequired
idObservable ID.Required
fieldObservable field to add. Possible values are: marking, label.Required
valueValue of the field to add. Enter label ID or marking definition ID. Use opencti-label-list to find all label IDs in OpenCTI, or use opencti-label-create to create a new label. Use opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Required

Context Output#

There is no context output for this command.

opencti-indicator-update#


Update a indicator in OpenCTI.

Base Command#

opencti-indicator-update

Input#

Argument NameDescriptionRequired
idID of the indicator.Required
nameName of the indicator.Optional
indicator_typesThe types of the indicator. Use opencti-indicator-types-list to find all indicator types in OpenCTI.Optional
descriptionThe description of the indicator.Optional
confidenceConfidence level for the indicator, value between 0 and 100. Default is 50. Default is 50.Optional
scoreThe score of the indicator, value between 0 and 100. Default is 50. Default is 50.Optional
valid_fromThe valid-from date for the indicator in the format YYYY-MM-DDThh:mm:ss.sssZ.Optional
valid_untilThe valid-until date for the indicator in the format YYYY-MM-DDThh:mm:ss.sssZ.Optional
label_idThe label ID for the indicator (use opencti-label-list to find or create).Optional
marking_idThe marking ID for the indicator (use opencti-marking-definition-list to find).Optional
external_references_idExternal references ID for the indicator (use opencti-external-reference-create to create).Optional

Context Output#

PathTypeDescription
OpenCTI.Indicator.idstringNew Indicator ID.
OpenCTI.Indicator.namestringName of the updated indicator.
OpenCTI.Indicator.validFromstringThe valid-from date of the updated indicator.
OpenCTI.Indicator.validUntilstringThe valid-until date of the updated indicator.

opencti-relationship-list#


Get a list of all relationships in OpenCTI.

Base Command#

opencti-relationship-list

Input#

Argument NameDescriptionRequired
from_idThe relationship from entity ID.Required
limitThe maximum number of relationships to return per fetch. Default value is 50. Maximum value is 200. Default is 50.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.Relationships.relationshipsLastRun context path.Optional

Context Output#

PathTypeDescription
OpenCTI.Relationships.RelationshipsList.idStringRelationship ID.
OpenCTI.Relationships.RelationshipsList.relationshipTypeStringRelationship type.
OpenCTI.Relationships.RelationshipsList.fromIdStringRelationship from entity ID.
OpenCTI.Relationships.RelationshipsList.toIdStringRelationship to entity ID.
OpenCTI.Relationships.RelationshipsList.toEntityTypeStringRelationship to entity type.
OpenCTI.Relationships.relationshipsLastRunStringThe last ID of the previous fetch to use for pagination.

opencti-observable-create#


Create new observable.

Base Command#

opencti-observable-create

Input#

Argument NameDescriptionRequired
typeThe observable type to create. Out-of-the-box observable types supported in XSOAR are: Account, Domain, Email, File-MD5, File-SHA1, File-SHA256, Host, IP, IPV6, Registry Key, and URL. Possible values are: Account, Domain, Email, File-MD5, File-SHA1, File-SHA256, Host, IP, IPv6, Registry Key, URL.Required
created_byOrganization ID. Use opencti-organization-list to find all organization IDs in OpenCTI, or use opencti-organization-create to create a new organization ID.Optional
marking_idObservable marking definition ID. Use opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Optional
label_idObservable label ID. Use opencti-label-list to find all label IDs in OpenCTI, or use opencti-label-create to create a new label.Optional
external_references_idExternal references URL. Use opencti-external-reference-create to create a new external reference.Optional
descriptionObservable description.Optional
scoreObservable score. Values range is 0 - 100. Default value is 50.Optional
valueObservable value.Optional
create_indicatorCreate OpenCTI indicator related with the OpenCTI observable created. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
OpenCTI.Observable.idStringNew observable ID.
OpenCTI.Observable.valueStringNew observable value.
OpenCTI.Observable.typeStringNew observable type.

opencti-get-observables#


Gets observables from OpenCTI.

Base Command#

opencti-get-observables

Input#

Argument NameDescriptionRequired
limitThe maximum number of observables to return. Default value is 50. Maximum value is 500.Optional
score_startScore minimum value to filter by. Values range is 0-100. .Optional
score_endScore maximum value to filter by. Values range is 0-100. .Optional
scoreA specific score. Values range is 0-100 or Unknown.Optional
observable_typesThe observable types to fetch. Out-of-the-box observable types supported in XSOAR are: Account, Domain, Email, File, Host, IP, IPv6, Registry Key, and URL. Possible values are: ALL, Account, Domain, Email, File, Host, IP, IPv6, Registry Key, URL. Default is ALL.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.ObservablesList.LastRunID context path.Optional
searchThe observable's value to filter by, can be partial value.Optional
all_resultsWhen the argument is set to true, the limit argument is ignored. Default is false. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
OpenCTI.Observables.ObservablesList.typeStringObservable type.
OpenCTI.Observables.ObservablesList.valueStringObservable value.
OpenCTI.Observables.ObservablesList.idStringObservable ID.
OpenCTI.Observables.ObservablesList.createdByUnknownThe creator of the observable.
OpenCTI.Observables.ObservablesList.scoreNumberObservable score.
OpenCTI.Observables.ObservablesList.descriptionStringObservable description.
OpenCTI.Observables.ObservablesList.labelsUnknownObservable labels.
OpenCTI.Observables.ObservablesList.markingUnknownObservable marking definitions.
OpenCTI.Observables.ObservablesList.externalReferencesUnknownObservable external references.
OpenCTI.Observables.LastRunIDStringThe last ID of the previous fetch to use for pagination.

opencti-relationship-delete#


Delete relationship.

Base Command#

opencti-relationship-delete

Input#

Argument NameDescriptionRequired
idRelationship ID.Required

Context Output#

There is no context output for this command.

opencti-observable-delete#


Delete observable.

Base Command#

opencti-observable-delete

Input#

Argument NameDescriptionRequired
idObservable ID.Required

Context Output#

There is no context output for this command.

opencti-observable-field-remove#


Remove observable field value. Fields which values can be removed are marking definition and label.

Base Command#

opencti-observable-field-remove

Input#

Argument NameDescriptionRequired
idObservable ID.Required
fieldObservable field to update. Possible values are: marking, label.Required
valueValue of the field to remove. Enter label ID or marking definition ID. Use opencti-label-list to find all label IDs in OpenCTI or opencti-marking-definition-list to find all marking definition IDs in OpenCTI.Required

Context Output#

There is no context output for this command.

opencti-observable-field-update#


Update the observable field. The fields that can be updated are: score, description.

Base Command#

opencti-observable-field-update

Input#

Argument NameDescriptionRequired
idObservable ID.Required
fieldObservable field to update. Possible values are: score, description.Required
valueValue of the field to update.Required

Context Output#

PathTypeDescription
OpenCTI.Observable.idStringUpdated observable ID.

opencti-indicator-types-list#


Get a list of all indicator types.

Base Command#

opencti-indicator-types-list

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
OpenCTI.IndicatorTypes.IndicatorTypesList.idunknownIndicator type ID.
OpenCTI.IndicatorTypes.IndicatorTypesList.nameunknownIndicator type name.
OpenCTI.IndicatorTypes.IndicatorTypesList.descriptionunknownIndicator type description.

opencti-incident-types-list#


Get a list of all incident types.

Base Command#

opencti-incident-types-list

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
OpenCTI.IncidentTypes.IncidentTypesList.idunknownIncident type ID.
OpenCTI.IncidentTypes.IncidentTypesList.nameunknownIncident type name.
OpenCTI.IncidentTypes.IncidentTypesList.descriptionunknownIncident type description.

opencti-get-incidents#


Get incidents in OpenCTI.

Base Command#

opencti-get-incidents

Input#

Argument NameDescriptionRequired
searchThe incident's value to filter by, can be partial value.Optional
created_byThe ID of the entity that created the incident (use opencti-organization-list to find or create).Optional
creatorThe ID of the incident creator.Optional
created_afterCreated after date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
created_beforeCreated before date filter. Format: YYYY-MM-DDThh:mm:ss.sssZ.Optional
incident_typesThe types of the incident. Use opencti-incident-types-list to find all incident types in OpenCTI.Optional
label_idThe label ID for the incident (use opencti-label-list to find or create).Optional
limitThe maximum number of incidents to return. Default value is 50. Maximum value is 500. Default is 50.Optional
last_run_idThe last ID from the previous call, from which to begin pagination for this call. You can find this value at the OpenCTI.Incidents.LastRunID context path.Optional
all_resultsWhen the argument is set to true, the limit argument is ignored. Default is false. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
OpenCTI.Incidents.IncidentList.idstringUnique ID of the incident.
OpenCTI.Incidents.IncidentList.namestringName of the incident.
OpenCTI.Incidents.IncidentList.descriptionstringDescription of the incident.
OpenCTI.Incidents.IncidentList.sourcestringThe source of the incident.
OpenCTI.Incidents.IncidentList.severitystringThe severity of the incident.
OpenCTI.Incidents.IncidentList.objectivestringThe objective date of the incident.
OpenCTI.Incidents.IncidentList.confidencenumberConfidence of the incident.
OpenCTI.Incidents.IncidentList.createdBystringName of the entity that created the incident.
OpenCTI.Incidents.IncidentList.creatorslistName of the incident creators.
OpenCTI.Incidents.IncidentList.labelslistLabels associated with the incident.
OpenCTI.Incidents.IncidentList.incidentTypeslistTypes of the incident.
OpenCTI.Incidents.IncidentList.createdstringCreation date of the incident.
OpenCTI.Incidents.IncidentList.updatedAtstringLast update date of the incident.
OpenCTI.Incidents.LastRunIDstringThe last ID of the previous fetch for pagination.