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

The Workflows API from Cisco XDR — 20 operation(s) for workflows.

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

This API exposes 26 operations across 20 paths, and defines 49 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}.

26 operations 20 paths 49 schemas 3 DELETE7 GET1 PATCH10 POST5 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 Workflows 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 26

Across 20 paths, the API surfaces 26 operations — 3 DELETE, 7 GET, 1 PATCH, 10 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 26
POST
/v1.1/workflows
Handler to get all workflows.
getAllWorkflowsPostQueryParams 7 params body → 200400403404500
POST
/v1.1/workflows/start
Handler to start workflow execution.
startWorkflowRequestV1Dot1 4 params body → 200202400403404412500
POST
/v1.2/workflows
Handler to get all workflows.
getAllWorkflowsPostQueryParamsV1Dot2 6 params body → 200400401403404500
GET
/v1/workflows
Handler to get all workflows.
getAllWorkflowsQueryParamsV1 2 params → 200400403404500
POST
/v1/workflows
Handler to create a workflow definition.
workflowCreateRequest body → 201400403404500
POST
/v1/workflows/batch_get
Handler to retrieve a list of workflows
workflowBatchGetPostRequest body → 200400403404500
POST
/v1/workflows/start
Handler to start workflow execution.
startWorkflowRequest 4 params body → 200202400403404412500
GET
/v1/workflows/start_config
Handler to return required input parameters for the workflow.
workflowInputParams 2 params → 200400403404500
GET
/v1/workflows/summary
Handler to get a summary of workflows.
worklowSummaryQueryParam → 200400403404500
GET
/v1/workflows/{workflow_id}
Handler to return workflow information using workflow ID.
getWorkflowById 1 param → 200400403404500
PUT
/v1/workflows/{workflow_id}
Handler to update the workflow.
workflowUpdateRequest 1 param body → 200400403404423500
DELETE
/v1/workflows/{workflow_id}
Handler to delete workflow using ID.
deleteWorkflowById 1 param → 202204400403404423500
POST
/v1/workflows/{workflow_id}/actions
Handler to add new action to workflow.
addActionRequest 1 param body → 200400403404423500
GET
/v1/workflows/{workflow_id}/actions/{action_id}
Handler to return Workflow's action information using action ID.
getActionById 2 params → 200400403404500
PUT
/v1/workflows/{workflow_id}/actions/{action_id}
Handler to update an Action.
actionUpdateRequest 2 params body → 200400403404423500
DELETE
/v1/workflows/{workflow_id}/actions/{action_id}
Handler to delete an action from workflow byId.
deleteActionById 2 params → 200400403404423500
PATCH
/v1/workflows/{workflow_id}/actions/{action_id}
Handler to move actions in workflow.
modifyActionStepsRequest 2 params body → 200400403404423500
POST
/v1/workflows/{workflow_id}/actions/{action_id}/duplicate
Handler to duplicate action.
duplicateActionById 2 params → 200400403404423500
PUT
/v1/workflows/{workflow_id}/lock
Handler to Lock the workflow.
workflowLockPutRequest 1 param body → 200400401403404423500
GET
/v1/workflows/{workflow_id}/references
Handler to return references for the workflow.
workflowObjRefRequestQueryParams 3 params → 200400403404500
GET
/v1/workflows/{workflow_id}/rules
Handler to return rules for the workflow.
getRulesByWorkflowID 1 param → 200400403404500
PUT
/v1/workflows/{workflow_id}/unlock
Handler to unlock a locked workflow. Param {workflowid} accepts both an id and uniquename of the workflow
unlockWorkflow 1 param → 200400401403404412500
POST
/v1/workflows/{workflow_id}/validate
Handler to validate workflow.
validateWorkflowParams 1 param → 200400403404423500
DELETE
/v1/{workflow_id}/uninstall
Handler to unintsall a workflow installed through exchange.
uninstallWorkflowById 2 params → 204400401403404412423500
POST
/v2/workflows
Handler to create a workflow definition from a given template.
templateWorkflowCreateRequest body → 201400403404500
PUT
/v2/workflows/{workflow_id}
Handler to update the workflow.
workflowUpdateRequestV2 1 param body → 200400403404423500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are workflowDefinitionGetResponse (27 properties), ActionDefinitionGetResponse (22 properties), WorkflowDefinitionGetAllResponse (21 properties), Trigger (17 properties). Each schema is shown below with its type and property counts.

ActionTableInfo
object
6 properties
workflowObjRefResponse
object
1 property
OutputInfo
object
3 properties
AddActionPostRequest
object
2 properties
VariableContent
object
8 properties
VariableGetAllResponse
object
VariableGetAllResponse model for variables
11 properties
Status
object
3 properties
Variable
object
15 properties 1 required
StartWorkflowResponse
object
StartWorkflowResponse model
10 properties
ActionDefinitionGetAllPropsResponse
object
17 properties
ActionOutputVariable
object
3 properties
WorkflowDefinitionPutResponse
object
WorkflowDefinitionPutResponse model for workflow put request API
3 properties
CourseOfAction
object
2 properties 1 required
StartWorklfowConfigResponse
object
6 properties
WFRuleResponse
object
11 properties
GitInfo
object
nolint: misspell GitInfo maintains information about the last Git Import
6 properties
WorkflowDefinitionPutRequest
object
10 properties
WorkflowDefinitionPutRequestV2
object
9 properties
StatusDetails
object
3 properties
ColumnMapInfo
object
{ "tabletypeid": "16bsMd7aS2mqII9n5bIe8EGIl39", "tabletypecolumns": { " ": [ { "name": "id", "type": "number" }, { "name": "name", "type": "string" } ] }, "par…
5 properties
ActionPatchRequest
object
2 properties
ColumnData
object
2 properties
RuleType
string
workflowDefinitionPostRequest
object
Either ViewSchemaID or Type or both can be provided to create a Workflow.
11 properties 2 required
WorkflowDefinitionGetAllResponse
object
21 properties
StartPointOption
object
2 properties
TriggerType
string
Trigger
object
17 properties
State
string
DefinitionState
ActionDefinitionGetResponse
object
22 properties
WorkflowsPostRequest
object
5 properties
WorkflowMetaData
object
1 property 1 required
WorkflowValidationGetResponse
object
5 properties
workflowSummaryResponse
object
3 properties
ActionDefinitionPutResponse
object
4 properties
ActionDefinitionPutRequest
object
5 properties
workflowDefinitionGetResponse
object
27 properties
TriggerStatus
object
4 properties
startWorklfowPostRequestPayload
object
StartWorklfowPostRequestPayload model
5 properties
LHObjType
string
ActionDefinitionPatchRequest
object
2 properties
VariableStartPutRequest
object
2 properties
templateDefinitionPostRequest
object
Type should be provided to create a Workflow.
3 properties 3 required
ActionDefinitionPostRequest
object
9 properties
WorkflowGetAllPaginationResponse
object
2 properties
PaginationLink
object
3 properties
WorkflowMetadata
object
WorkflowMetadata maintains miscellaneous metadata for the workflow
4 properties
WorkflowLock
object
3 properties
DynamicMap
object
DynamicMap ..
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-xdr-workflows-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 Workflows 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.