How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco XDR Note API

The Note API from Cisco XDR — 8 operation(s) for note.

Cisco XDR Note API is one of 83 APIs that Cisco XDR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Note, Security, XDR, and Threat Detection. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 4178275a824512c2fd3a2acdb0e8277233919054 v2.71.0.

Requests are made against a single base URL, /.

12 operations 8 paths 11 schemas 2 DELETE7 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4178275a824512c2fd3a2acdb0e8277233919054 v2.71.0
Base URL
https://private.intel.amp.cisco.com
Authentication
API Key, OAuth 2.0
License
All Rights Reserved
Resource Areas
1

Authentication & Security 2

Cisco XDR Note API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (JWT). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • JWT — Ex: Bearer \

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 7 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Note 12
POST
/ctia/note
Adds a new Note
1 param body → 201
PUT
/ctia/note/{id}
Update an existing Note
2 params body → 200
PATCH
/ctia/note/{id}
Partially update an existing Note
2 params body → 200
GET
/ctia/note/{id}
Get one Note by ID
2 params → 200
DELETE
/ctia/note/{id}
Delete one Note
2 params → 204
GET
/ctia/note/external_id/{external_id}
List Note by external id
7 params → 200
GET
/ctia/note/search
Search for Note entities using a ES query syntax and field filters
19 params → 200
DELETE
/ctia/note/search
Delete Note entities matching given Lucene/ES query string or/and field filters
16 params → 200
GET
/ctia/note/search/count
Count Note matching a Lucene/ES query string and field filters
14 params → 200
GET
/ctia/note/metric/histogram
Histogram for some Note field
18 params → 200
GET
/ctia/note/metric/topn
Topn for some Note field
18 params → 200
GET
/ctia/note/metric/cardinality
Cardinality for some Note field
15 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PartialNewNote (22 properties), NewNote (22 properties), PartialNote (22 properties), Note (15 properties). Each schema is shown below with its type and property counts.

MetricResultFilters
object
2 properties 2 required
NoteRelatedEntity
object
2 properties 2 required
ExternalReference
object
External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to…
5 properties 1 required
PartialNewNoteRelatedEntities
object
2 properties
NewNote
object
a new Note
22 properties 3 required
PartialNewNote
object
Note partial update
22 properties
Note
object
A Note is intended to convey informative text to provide further context and/or to provide additional analysis not contained in the Objects, assigning Text/con…
15 properties
MetricResultData
object
PartialNewNoteExternalReferences
object
External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to…
5 properties
MetricResult
object
3 properties 3 required
PartialNote
object
A Note is intended to convey informative text to provide further context and/or to provide additional analysis not contained in the Objects, assigning Text/con…
22 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-xdr-note-api-openapi.yml Raw ↑

Other APIs Cisco XDR publishes across the network.

Cisco XDR Actor API
Cisco XDR Asset API
Cisco XDR Asset Mapping API
Cisco XDR Asset Properties API
Cisco XDR Attack Pattern API
Cisco XDR Bulk API
Cisco XDR Bundle API
Cisco XDR Campaign API
Cisco XDR Casebook API
Cisco XDR COA API
Cisco XDR Deliberate API
Cisco XDR Event API
Where this information came from

This is an independent, third-party profile of Cisco XDR Note API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.