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 Rules API

The Rules API from Cisco XDR — 4 operation(s) for rules.

Cisco XDR Rules 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 Rules. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://automate.us.security.cisco.com/{basePath}.

6 operations 4 paths 14 schemas 1 DELETE1 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://private.intel.amp.cisco.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Cisco XDR Rules API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2) using the clientCredentials flow, exposing 26 scopes. By default, every request must be authenticated.

Paths & Operations 6

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

Rules 6
POST
/v1/rules
Handler to create a rule
RuleCreateRequest body → 201400401403500
POST
/v1/rules/batch_get
Handler to get all rules.
getAllRulesQueryParam 5 params body → 200400401403404500
PATCH
/v1/rules/priority
Handler to update a rule
rulePriorityOrderRequest body → 200400401403404500
GET
/v1/rules/{rule_id}
Handler to get rule by ID.
getRuleRequest 1 param → 200400401403404500
PUT
/v1/rules/{rule_id}
Handler to update a rule
RuleUpdateRequest 1 param body → 200400401403404500
DELETE
/v1/rules/{rule_id}
Handler to delete rule
DeleteRuleByID 1 param → 204400403404412500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GetAllRuleResponse (21 properties), Rule (18 properties), RulePostRequest (7 properties), RulePutRequest (4 properties). Each schema is shown below with its type and property counts.

GetAllRuleResponse
object
21 properties
RulePutRequest
object
RulePutRequest struct for rule put api
4 properties 2 required
GetAllRulesPaginatedResponse
object
3 properties
RuleStatus
object
4 properties
PrevRulePriorityPatchRequest
object
1 property
RulesPostRequest
object
3 properties
Rule
object
18 properties 1 required
State
string
DefinitionState
StatusDetails
object
3 properties
RulePostRequest
object
RulePostRequest struct for rule post api Either ViewSchemaID or Type or both can be provided to create an Rule.
7 properties 2 required
PaginationLink
object
3 properties
RulePatchRequest
object
RulePatchRequest struct for rule patch api
3 properties
RuleType
string
RulePriorityPatchRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-xdr-rules-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 Rules 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.