Kibana integration: operations for AI agents
Kibana connects to Type.com as an integration. This page lists the 730 operations documented for Claude and Codex in Type.com: 285 read, 279 write, 166 destructive.
About Kibana
Kibana is a visualization and analytics platform for Elasticsearch, offering dashboards, data exploration, and monitoring capabilities for gaining insights from data
Categories: Analytics & Data
How to connect Kibana to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
730 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
730 operations listed.
Connectors
- Read
Get connector types
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connectortypes Refer to Spaces for more information. You do not need any Kibana feature privileges to run this API.
- Read
Handle OAuth callback
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connector/oauthcallback Refer to Spaces for more information. Handles the OAuth 2.0 authorization code callback from external providers. Exchanges the authorization code for access and refresh tokens.
- Read
Get OAuth callback script
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connector/oauthcallbackscript Refer to Spaces for more information. Returns the OAuth callback script
- Read
Start OAuth authorization (redirects to the identity provider)
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connector/{connectorId}/oauth/start Refer to Spaces for more information. [Required authorization] Route required privileges: actions:oauth.
- Read
Get connector information
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connector/{id} Refer to Spaces for more information.
- Read
Get all connectors
Spaces method and path for this operation: get /s/{spaceid}/api/actions/connectors Refer to Spaces for more information.
- Write
Create a connector
Spaces method and path for this operation: post /s/{spaceid}/api/actions/connector/{id} Refer to Spaces for more information.
- Write
Run a connector
Spaces method and path for this operation: post /s/{spaceid}/api/actions/connector/{id}/execute Refer to Spaces for more information. You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
- Write
Ingest an external event for a Kibana connector
Spaces method and path for this operation: post /s/{spaceid}/api/actions/events/{connectortypeid}/{connectorid} Refer to Spaces for more information. Public ingress for Kibana connector-scoped inbound events.
- Destructive
Update a connector
Spaces method and path for this operation: put /s/{spaceid}/api/actions/connector/{id} Refer to Spaces for more information.
- Destructive
Delete a connector
Spaces method and path for this operation: delete /s/{spaceid}/api/actions/connector/{id} Refer to Spaces for more information. WARNING: When you delete a connector, it cannot be recovered.
Agent builder
- Read
Get A2A agent card
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/a2a/{agentId}.json Refer to Spaces for more information. Get agent discovery metadata in JSON format. Use this endpoint to provide agent information for A2A protocol integration and discovery.
- Read
List agents
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/agents Refer to Spaces for more information. List all available agents. Use this endpoint to retrieve complete agent information including their current configuration and assigned tools.
- Read
Get agent consumption data
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/agents/{agentid}/consumption Refer to Spaces for more information. Returns paginated, per-conversation token consumption data for a given agent.
- Read
Get an agent by ID
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/agents/{id} Refer to Spaces for more information. Get a specific agent by ID. Use this endpoint to retrieve the complete agent definition including all configuration details and tool assignments.
- Read
Get an agent's access control list
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/agents/{id}/accesscontrol Refer to Spaces for more information. Get the access control for a specific agent.
- Read
List conversations
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/conversations Refer to Spaces for more information. List all conversations for a user. Use the optional agent ID to filter conversations by a specific agent.
- Read
Get conversation by ID
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/conversations/{conversationid} Refer to Spaces for more information. Get a specific conversation by ID.
- Read
List conversation attachments
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments Refer to Spaces for more information. List all attachments for a conversation.
- Read
Get conversation attachment
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid} Refer to Spaces for more information. Get a single attachment by ID for a conversation.
- Read
Check attachment staleness
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/stale Refer to Spaces for more information. Checks staleness for the latest version of all conversation attachments against their origin snapshot.
- Read
List plugins
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/plugins Refer to Spaces for more information. List all installed plugins and their managed assets.
- Read
Get a plugin by id
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/plugins/{pluginId} Refer to Spaces for more information. Get a specific plugin by ID. To learn more about Agent Builder plugins, refer to the plugins documentation.
- Read
List skills
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/skills Refer to Spaces for more information. List all available skills (built-in and user-created). To learn more about Agent Builder skills, refer to the skills documentation.
- Read
Get a skill by id
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/skills/{skillId} Refer to Spaces for more information. Get a specific skill by ID. To learn more about Agent Builder skills, refer to the skills documentation.
- Read
List tools
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/tools Refer to Spaces for more information. List all available tools. Use this endpoint to retrieve complete tool definitions including their schemas and configuration requirements.
- Read
Get a tool by id
Spaces method and path for this operation: get /s/{spaceid}/api/agentbuilder/tools/{toolId} Refer to Spaces for more information. Get a specific tool by ID. Use this endpoint to retrieve the complete tool definition including its schema and configuration requirements.
- Write
Send A2A task
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/a2a/{agentId} Refer to Spaces for more information. warn This endpoint is designed for A2A protocol clients and should not be used directly via REST APIs. Use an A2A SDK or A2A Inspector instead.
- Write
Create an agent
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/agents Refer to Spaces for more information. Create a new agent. Use this endpoint to define the agent's behavior, appearance, and capabilities through comprehensive configuration options.
- Write
Create conversation
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/conversations Refer to Spaces for more information. Create an empty conversation without sending a message. Returns the created conversation immediately.
- Write
Add events to a conversation
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/addevents Refer to Spaces for more information. Append custom events to a conversation's timeline.
- Write
Create conversation attachment
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments Refer to Spaces for more information. Create a new attachment for a conversation with version tracking.
- Write
Rename attachment
Spaces method and path for this operation: patch /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid} Refer to Spaces for more information. Rename an attachment without creating a new version.
- Write
Restore deleted attachment
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid}/restore Refer to Spaces for more information. Restore a soft-deleted attachment.
- Write
Send chat message
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/converse Refer to Spaces for more information. Send a message to an agent and receive a complete response.
- Write
Send chat message (streaming)
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/converse/async Refer to Spaces for more information. Send a message to an agent and receive real-time streaming events.
- Write
MCP server
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/mcp Refer to Spaces for more information. warn This endpoint is designed for MCP clients (Claude Desktop, Cursor, VS Code, etc.) and should not be used directly via REST APIs.
- Write
Install a plugin
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/plugins/install Refer to Spaces for more information. Install a plugin from a GitHub Claude plugin URL or a direct ZIP URL. Plugins bundle agent capabilities such as skills.
- Write
Create a skill
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/skills Refer to Spaces for more information. Create a new user-defined skill. To learn more about Agent Builder skills, refer to the skills documentation.
- Write
Create a tool
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/tools Refer to Spaces for more information. Create a new tool. Use this endpoint to define a custom tool with specific functionality and configuration for use by agents.
- Write
Run a tool
Spaces method and path for this operation: post /s/{spaceid}/api/agentbuilder/tools/execute Refer to Spaces for more information. Run a tool with parameters. Use this endpoint to run a tool directly with specified inputs and optional external connector integration.
- Write
Send a message and get the answer
Spaces method and path for this operation: post /s/{spaceid}/api/chat/message Refer to Spaces for more information. Send a message to an agent and get its text answer. Use this synchronous endpoint in scripts and command-line tools.
- Destructive
Update an agent
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/agents/{id} Refer to Spaces for more information. Update an existing agent configuration. Use this endpoint to modify any aspect of the agent's behavior, appearance, or capabilities.
- Destructive
Delete an agent
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/agents/{id} Refer to Spaces for more information. Delete an agent by ID. This action cannot be undone. To learn more about agents, refer to the agents documentation.
- Destructive
Update an agent's access control list
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/agents/{id}/accesscontrol Refer to Spaces for more information. Replace the per-agent access-control entries. Each entry grants one user a role on this agent.
- Destructive
Delete conversation by ID
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/conversations/{conversationid} Refer to Spaces for more information. Delete a conversation by ID. This action cannot be undone.
- Destructive
Update a conversation's access control
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/accesscontrol Refer to Spaces for more information. Replace a conversation's access mode and member list.
- Destructive
Update conversation attachment
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid} Refer to Spaces for more information. Update an attachment content. Creates a new version if content changed.
- Destructive
Delete conversation attachment
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid} Refer to Spaces for more information. Delete an attachment. By default performs a soft delete (can be restored).
- Destructive
Update attachment origin
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/conversations/{conversationid}/attachments/{attachmentid}/origin Refer to Spaces for more information. Update the origin reference for an attachment.
- Destructive
Delete a plugin
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/plugins/{pluginId} Refer to Spaces for more information. Delete an installed plugin by ID. This action cannot be undone.
- Destructive
Update a skill
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/skills/{skillId} Refer to Spaces for more information. Update an existing user-created skill. To learn more about Agent Builder skills, refer to the skills documentation.
- Destructive
Delete a skill
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/skills/{skillId} Refer to Spaces for more information. Delete a user-created skill by ID.
- Destructive
Update a tool
Spaces method and path for this operation: put /s/{spaceid}/api/agentbuilder/tools/{toolId} Refer to Spaces for more information. Update an existing tool. Use this endpoint to modify any aspect of the tool's configuration or metadata.
- Destructive
Delete a tool
Spaces method and path for this operation: delete /s/{spaceid}/api/agentbuilder/tools/{toolId} Refer to Spaces for more information. Delete a tool by ID. This action cannot be undone. To learn more about Agent Builder tools, refer to the tools documentation.
Alerting
- Read
Get the alerting framework health
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/health Refer to Spaces for more information.
- Read
Get the rule types
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/ruletypes Refer to Spaces for more information. If you have read privileges for one or more Kibana features, the API response contains information about the appropriate rule types.
- Read
Get rule details
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/rule/{id} Refer to Spaces for more information.
- Read
Get the Elasticsearch query for a rule
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/rule/{id}/queryinspector Refer to Spaces for more information. Returns the Elasticsearch query that a rule executes, and optionally its response.
- Read
Get information about rules
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/rules/find Refer to Spaces for more information.
- Read
Find backfills for rules
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rules/backfill/find Refer to Spaces for more information.
- Read
Get a backfill by ID
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/rules/backfill/{id} Refer to Spaces for more information.
- Write
Create a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id} Refer to Spaces for more information.
- Write
Disable a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/disable Refer to Spaces for more information.
- Write
Enable a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/enable Refer to Spaces for more information.
- Write
Mute all alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/muteall Refer to Spaces for more information.
- Write
Unmute all alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/unmuteall Refer to Spaces for more information.
- Write
Update the API key for a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/updateapikey Refer to Spaces for more information.
- Write
Schedule a snooze for the rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{id}/snoozeschedule Refer to Spaces for more information. When you snooze a rule, the rule checks continue to run but alerts will not generate actions.
- Write
Mute an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{ruleid}/alert/{alertid}/mute Refer to Spaces for more information.
- Write
Snooze an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{ruleid}/alert/{alertid}/snooze Refer to Spaces for more information.
- Write
Unmute an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{ruleid}/alert/{alertid}/unmute Refer to Spaces for more information.
- Write
Unsnooze an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rule/{ruleid}/alert/{alertid}/unsnooze Refer to Spaces for more information.
- Write
Schedule a backfill for rules
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/rules/backfill/schedule Refer to Spaces for more information.
- Destructive
Update a rule
Spaces method and path for this operation: put /s/{spaceid}/api/alerting/rule/{id} Refer to Spaces for more information.
- Destructive
Delete a rule
Spaces method and path for this operation: delete /s/{spaceid}/api/alerting/rule/{id} Refer to Spaces for more information.
- Destructive
Delete a snooze schedule for a rule
Spaces method and path for this operation: delete /s/{spaceid}/api/alerting/rule/{ruleId}/snoozeschedule/{scheduleId} Refer to Spaces for more information.
- Destructive
Delete a backfill by ID
Spaces method and path for this operation: delete /s/{spaceid}/api/alerting/rules/backfill/{id} Refer to Spaces for more information.
Alerting v2
- Read
List action policies
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/actionpolicies Refer to Spaces for more information. Get a paginated list of action policies with optional filtering and sorting.
- Read
Get an action policy
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/actionpolicies/{id} Refer to Spaces for more information. Get an action policy by identifier. [Required authorization] Route required privileges: readalerting-v2-action-policies.
- Read
List action policy executions
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/executionhistory/actionpolicies Refer to Spaces for more information. Get a paginated list of dispatcher summary events for action policies in the current space.
- Read
List rule executions
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/executionhistory/rules Refer to Spaces for more information. Get a paginated list of rule execution events. [Required authorization] Route required privileges: readalerting-v2-execution-history.
- Read
List rules
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/rules Refer to Spaces for more information. [Required authorization] Route required privileges: readalerting-v2-rules.
- Read
Get rules in bulk
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkget Refer to Spaces for more information. Returns the requested rules. Ids that match no rule are reported per item in errors as RULENOTFOUND.
- Read
Get a rule
Spaces method and path for this operation: get /s/{spaceid}/api/alerting/v2/rules/{id} Refer to Spaces for more information. [Required authorization] Route required privileges: readalerting-v2-rules.
- Write
Create an action policy
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies Refer to Spaces for more information. Creates an action policy with a server-generated identifier.
- Write
Disable action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulkdisable Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Enable action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulkenable Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Snooze action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulksnooze Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Rotate API keys for action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulkupdateapikey Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Partially update an action policy.
Spaces method and path for this operation: patch /s/{spaceid}/api/alerting/v2/actionpolicies/{id} Refer to Spaces for more information. Apply a partial update.
- Write
Disable an action policy
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/{id}/disable Refer to Spaces for more information. Disable an action policy by identifier. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Enable an action policy
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/{id}/enable Refer to Spaces for more information. Enable an action policy by identifier. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Snooze an action policy
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/{id}/snooze Refer to Spaces for more information. Snooze an action policy until a specified time.
- Write
Unsnooze an action policy
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/{id}/unsnooze Refer to Spaces for more information. Remove the snooze from an action policy. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Write
Update an action policy API key
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/{id}/updateapikey Refer to Spaces for more information. Rotate the API key for an action policy.
- Write
Bulk acknowledge alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulkack Refer to Spaces for more information. Create the same action for multiple alerts in a single request. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Bulk activate alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulkactivate Refer to Spaces for more information. Create the same action for multiple alerts in a single request.
- Write
Bulk assign alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulkassign Refer to Spaces for more information. Create the same action for multiple alerts in a single request.
- Write
Bulk deactivate alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulkdeactivate Refer to Spaces for more information. Create the same action for multiple alerts in a single request.
- Write
Bulk tag alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulktag Refer to Spaces for more information. Create the same action for multiple alerts in a single request. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Bulk unacknowledge alerts
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/bulkunack Refer to Spaces for more information. Create the same action for multiple alerts in a single request. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Acknowledge an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/ack Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Activate an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/activate Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Assign an alert to a user
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/assign Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Deactivate an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/deactivate Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Tag an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/tag Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Unacknowledge an alert
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/alerts/{id}/unack Refer to Spaces for more information. Create an action for a specific alert. [Required authorization] Route required privileges: managealerting-v2-alerts.
- Write
Create a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules Refer to Spaces for more information. Creates a rule with a server-generated identifier. To create or replace a rule with a client-supplied identifier, use PUT /api/alerting/v2/rules/{id}/.
- Write
Create rules in bulk
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkcreate Refer to Spaces for more information. Creates up to 100 rules in a single request. Each item can include a client-supplied id. Kibana generates an identifier when id is omitted.
- Write
Disable rules in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkdisable Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Enable rules in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkenable Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Update the API key of rules in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkupdateapikey Refer to Spaces for more information. Rotates each rule executor task API key to one derived from the current user’s credentials.
- Write
Disable rules matching a query (dry-run by default)
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/disablebyquery Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Enable rules matching a query (dry-run by default)
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/enablebyquery Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Update the API key of rules matching a query (dry-run by default)
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/updateapikeybyquery Refer to Spaces for more information. Rotates each matching rule executor task API key to one derived from the current user’s credentials.
- Write
Update a rule
Spaces method and path for this operation: patch /s/{spaceid}/api/alerting/v2/rules/{id} Refer to Spaces for more information. Apply a partial update.
- Write
Disable a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/{id}/disable Refer to Spaces for more information. Disable a rule by identifier. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Enable a rule
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/{id}/enable Refer to Spaces for more information. Enable a rule by identifier. [Required authorization] Route required privileges: managealerting-v2-rules.
- Write
Run a rule now
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/{id}/run Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Destructive
Delete action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulkdelete Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Destructive
Cancel snooze for action policies in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/actionpolicies/bulkunsnooze Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-action-policies.
- Destructive
Create or replace an action policy
Spaces method and path for this operation: put /s/{spaceid}/api/alerting/v2/actionpolicies/{id} Refer to Spaces for more information. Creates an action policy with the given identifier, or fully replaces it if one already exists.
- Destructive
Delete an action policy
Spaces method and path for this operation: delete /s/{spaceid}/api/alerting/v2/actionpolicies/{id} Refer to Spaces for more information. Deletes the action policy whose ID you include in the URL path. Use the id returned when you created the policy, or from get or list.
- Destructive
Delete rules in bulk by ID
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/bulkdelete Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Destructive
Delete rules matching a query (dry-run by default)
Spaces method and path for this operation: post /s/{spaceid}/api/alerting/v2/rules/deletebyquery Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
- Destructive
Create or replace a rule
Spaces method and path for this operation: put /s/{spaceid}/api/alerting/v2/rules/{id} Refer to Spaces for more information. Creates a rule with the given identifier, or fully replaces it if one already exists.
- Destructive
Delete a rule
Spaces method and path for this operation: delete /s/{spaceid}/api/alerting/v2/rules/{id} Refer to Spaces for more information. [Required authorization] Route required privileges: managealerting-v2-rules.
APM agent keys
- Write
Create an APM agent key
Spaces method and path for this operation: post /s/{spaceid}/api/apm/agentkeys Refer to Spaces for more information. Create a new agent key for APM.
APM annotations
- Read
Search for annotations
Spaces method and path for this operation: get /s/{spaceid}/api/apm/services/{serviceName}/annotation/search Refer to Spaces for more information. Search for annotations related to a specific service.
- Write
Create a service annotation
Spaces method and path for this operation: post /s/{spaceid}/api/apm/services/{serviceName}/annotation Refer to Spaces for more information. Create a new annotation for a specific service.
APM agent configuration
- Read
Get a list of agent configurations
Spaces method and path for this operation: get /s/{spaceid}/api/apm/settings/agent-configuration Refer to Spaces for more information. Retrieve all agent configurations. You must have read privileges for the APM and User Experience feature in Kibana.
- Read
Get agent name for service
Spaces method and path for this operation: get /s/{spaceid}/api/apm/settings/agent-configuration/agentname Refer to Spaces for more information. Retrieve agentName for a service.
- Read
Get environments for service
Spaces method and path for this operation: get /s/{spaceid}/api/apm/settings/agent-configuration/environments Refer to Spaces for more information. Retrieve the available environments for a given service, to be used in agent configuration.
- Read
Get single agent configuration
Spaces method and path for this operation: get /s/{spaceid}/api/apm/settings/agent-configuration/view Refer to Spaces for more information. Retrieve a single agent configuration matching the given service name and environment.
- Destructive
Create or update agent configuration
Spaces method and path for this operation: put /s/{spaceid}/api/apm/settings/agent-configuration Refer to Spaces for more information. Create or update an agent configuration. You must have all privileges for the APM and User Experience feature in Kibana.
- Destructive
Delete agent configuration
Spaces method and path for this operation: delete /s/{spaceid}/api/apm/settings/agent-configuration Refer to Spaces for more information. Delete an existing agent configuration. You must have all privileges for the APM and User Experience feature in Kibana.
APM sourcemaps
- Read
Get source maps
Spaces method and path for this operation: get /s/{spaceid}/api/apm/sourcemaps Refer to Spaces for more information. Get an array of Fleet artifacts, including source map uploads. You must have read or all Kibana privileges for the APM and User Experience feature.
- Write
Upload a source map
Spaces method and path for this operation: post /s/{spaceid}/api/apm/sourcemaps Refer to Spaces for more information. Upload a source map for a specific service and version. You must have all Kibana privileges for the APM and User Experience feature.
- Destructive
Delete source map
Spaces method and path for this operation: delete /s/{spaceid}/api/apm/sourcemaps/{id} Refer to Spaces for more information. Delete a previously uploaded source map. You must have all Kibana privileges for the APM and User Experience feature.
Security Attack discovery API
- Read
Find Attack discoveries that match the search criteria
Spaces method and path for this operation: get /s/{spaceid}/api/attackdiscovery/find Refer to Spaces for more information. Find Attack discoveries that match the search criteria. Supports free text search, filtering, pagination, and sorting.
- Read
Get the latest Attack Discovery generations metadata for the current user
Spaces method and path for this operation: get /s/{spaceid}/api/attackdiscovery/generations Refer to Spaces for more information. Get the latest Attack Discovery generations metadata (that are not dismissed) for the current user.
- Read
Get a single Attack Discovery generation, including its discoveries and (optional) generation metadata
Spaces method and path for this operation: get /s/{spaceid}/api/attackdiscovery/generations/{executionuuid} Refer to Spaces for more information.
- Read
Find Attack Discovery schedules that match the search criteria
Spaces method and path for this operation: get /s/{spaceid}/api/attackdiscovery/schedules/find Refer to Spaces for more information. Find Attack Discovery schedules that match the search criteria. Supports pagination and sorting by various fields.
- Read
Get Attack Discovery schedule by ID
Spaces method and path for this operation: get /s/{spaceid}/api/attackdiscovery/schedules/{id} Refer to Spaces for more information. Retrieves a specific Attack Discovery schedule by its unique identifier.
- Write
Bulk update Attack discoveries
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/bulk Refer to Spaces for more information. Performs bulk updates on multiple Attack discoveries, including workflow status changes and visibility settings.
- Write
Generate attack discoveries from alerts
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/generate Refer to Spaces for more information. Initiates the generation of attack discoveries by analyzing security alerts using AI.
- Write
Dismiss an Attack Discovery generation
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/generations/{executionuuid}/dismiss Refer to Spaces for more information.
- Write
Create Attack Discovery schedule
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules Refer to Spaces for more information. Creates a new Attack Discovery schedule that analyzes security alerts at specified intervals.
- Write
Bulk delete Attack Discovery schedules
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules/bulkdelete Refer to Spaces for more information. Deletes multiple Attack Discovery schedules by ID.
- Write
Bulk disable Attack Discovery schedules
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules/bulkdisable Refer to Spaces for more information. Disables multiple Attack Discovery schedules by ID.
- Write
Bulk enable Attack Discovery schedules
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules/bulkenable Refer to Spaces for more information. Enables multiple Attack Discovery schedules by ID.
- Write
Disable Attack Discovery schedule
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules/{id}/disable Refer to Spaces for more information. Disables an Attack Discovery schedule, preventing it from running according to its configured interval.
- Write
Enable Attack Discovery schedule
Spaces method and path for this operation: post /s/{spaceid}/api/attackdiscovery/schedules/{id}/enable Refer to Spaces for more information. Enables a previously disabled Attack Discovery schedule, allowing it to run according to its configured interval.
- Destructive
Update Attack Discovery schedule
Spaces method and path for this operation: put /s/{spaceid}/api/attackdiscovery/schedules/{id} Refer to Spaces for more information. Updates an existing Attack Discovery schedule with new configuration.
- Destructive
Delete Attack Discovery schedule
Spaces method and path for this operation: delete /s/{spaceid}/api/attackdiscovery/schedules/{id} Refer to Spaces for more information. Permanently deletes an Attack Discovery schedule and all associated configuration.
Cases
- Read
Search cases
Spaces method and path for this operation: get /s/{spaceid}/api/cases/find Refer to Spaces for more information.
- Read
Get case information
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId} Refer to Spaces for more information. Returns case details. The response does not include a comments property; use the find case comments API to retrieve comments.
- Read
Get all alerts for a case
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId}/alerts Refer to Spaces for more information.
- Read
Find case comments
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId}/comments/find Refer to Spaces for more information. Retrieves a paginated list of comments for a case.
- Read
Get a case comment or alert
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId}/comments/{commentId} Refer to Spaces for more information.
- Read
Get the fields applicable to an existing case
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId}/fields Refer to Spaces for more information. Returns the fields you can write to the case's extendedfields. The case determines the owner and any applied template.
- Read
Find case activity
Spaces method and path for this operation: get /s/{spaceid}/api/cases/{caseId}/useractions/find Refer to Spaces for more information. Retrieves a paginated list of user activity for a case.
- Read
Get cases for an alert
Spaces method and path for this operation: get /s/{spaceid}/api/cases/alerts/{alertId} Refer to Spaces for more information.
- Read
Get case settings
Spaces method and path for this operation: get /s/{spaceid}/api/cases/configure Refer to Spaces for more information. Get setting details such as the closure type, custom fields, templates, and the default connector for cases.
- Read
Get case connectors
Spaces method and path for this operation: get /s/{spaceid}/api/cases/configure/connectors/find Refer to Spaces for more information. Get information about connectors that are supported for use in cases.
- Read
Get all field definitions
Spaces method and path for this operation: get /s/{spaceid}/api/cases/fielddefinitions Refer to Spaces for more information. Returns a paginated list of field definitions (field library entries) for the given owner. Requires the Cases feature to be enabled in the space.
- Read
Get a field definition by ID
Spaces method and path for this operation: get /s/{spaceid}/api/cases/fielddefinitions/{fielddefinitionid} Refer to Spaces for more information. Returns a single field definition by its ID. Requires the Cases feature to be enabled in the space.
- Read
Get the fields applicable to a case
Spaces method and path for this operation: get /s/{spaceid}/api/cases/fields Refer to Spaces for more information. Returns the fields you can write to a case's extendedfields when creating a case for the given owner.
- Read
Get case creators
Returns information about the users who opened cases. You must have read privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases.
- Read
Get case tags
Spaces method and path for this operation: get /s/{spaceid}/api/cases/tags Refer to Spaces for more information. Aggregates and returns a list of case tags.
- Read
Get all case templates
Spaces method and path for this operation: get /s/{spaceid}/api/cases/templates Refer to Spaces for more information. Returns a paginated list of case templates. Requires the Cases feature to be enabled in the space.
- Read
Get a case template by ID
Spaces method and path for this operation: get /s/{spaceid}/api/cases/templates/{templateid} Refer to Spaces for more information. Returns the details of a case template. Requires the Cases feature to be enabled in the space.
- Write
Create a case
Spaces method and path for this operation: post /s/{spaceid}/api/cases Refer to Spaces for more information.
- Write
Update cases
Spaces method and path for this operation: patch /s/{spaceid}/api/cases Refer to Spaces for more information.
- Write
Add a case comment or alert
Spaces method and path for this operation: post /s/{spaceid}/api/cases/{caseId}/comments Refer to Spaces for more information.
- Write
Update a case comment or alert
Spaces method and path for this operation: patch /s/{spaceid}/api/cases/{caseId}/comments Refer to Spaces for more information.
- Write
Push a case to an external service
Spaces method and path for this operation: post /s/{spaceid}/api/cases/{caseId}/connector/{connectorId}/push Refer to Spaces for more information.
- Write
Attach a file to a case
Spaces method and path for this operation: post /s/{spaceid}/api/cases/{caseId}/files Refer to Spaces for more information. Attach a file to a case.
- Write
Add case settings
Spaces method and path for this operation: post /s/{spaceid}/api/cases/configure Refer to Spaces for more information. Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems.
- Write
Update case settings
Spaces method and path for this operation: patch /s/{spaceid}/api/cases/configure/{configurationId} Refer to Spaces for more information. Updates setting details such as the closure type, custom fields, templates, and the default connector for cases.
- Write
Create a field definition
Spaces method and path for this operation: post /s/{spaceid}/api/cases/fielddefinitions Refer to Spaces for more information. Creates a field definition in the field library. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution.
- Write
Create a case template
Spaces method and path for this operation: post /s/{spaceid}/api/cases/templates Refer to Spaces for more information. Creates a case template from a YAML definition. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution.
- Destructive
Delete cases
Spaces method and path for this operation: delete /s/{spaceid}/api/cases Refer to Spaces for more information.
- Destructive
Delete all case comments and alerts
Spaces method and path for this operation: delete /s/{spaceid}/api/cases/{caseId}/comments Refer to Spaces for more information. Deletes all comments and alerts from a case. The files of any file attachments are also deleted.
- Destructive
Delete a case comment or alert
Spaces method and path for this operation: delete /s/{spaceid}/api/cases/{caseId}/comments/{commentId} Refer to Spaces for more information. Deletes a comment or alert from a case. If it is a file attachment, its file is also deleted.
- Destructive
Update a field definition
Spaces method and path for this operation: put /s/{spaceid}/api/cases/fielddefinitions/{fielddefinitionid} Refer to Spaces for more information. Updates editable attributes of a field definition. Server-managed attributes (displayOrder, legacyKey) are preserved.
- Destructive
Delete a field definition
Spaces method and path for this operation: delete /s/{spaceid}/api/cases/fielddefinitions/{fielddefinitionid} Refer to Spaces for more information. Deletes a field definition. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution.
- Destructive
Update a case template
Spaces method and path for this operation: put /s/{spaceid}/api/cases/templates/{templateid} Refer to Spaces for more information. Fully replaces a case template.
- Destructive
Delete a case template
Spaces method and path for this operation: delete /s/{spaceid}/api/cases/templates/{templateid} Refer to Spaces for more information. Soft-deletes a case template (all versions).
Context engine
- Read
List AI Indices
Spaces method and path for this operation: get /s/{spaceid}/api/contextengine/aiindex Refer to Spaces for more information. Lists up to 100 AI Indices in the current space that the caller can read.
- Read
Query AI Indices
Spaces method and path for this operation: post /s/{spaceid}/api/contextengine/aiindex/query Refer to Spaces for more information. Runs an ES|QL query as the current user. The server applies a space filter and limits the response to at most 1000 rows.
- Read
Get an AI Index
Spaces method and path for this operation: get /s/{spaceid}/api/contextengine/aiindex/{aiIndexId} Refer to Spaces for more information. Fetches an AI Index by ID from the current space, including the ES|QL query derived from each trace.
- Read
Describe an AI Index
Spaces method and path for this operation: get /s/{spaceid}/api/contextengine/aiindex/{aiIndexId}/describe Refer to Spaces for more information. Returns a free-form text context block for an agent. The block describes the AI Index and its ES|QL target.
- Write
Create an AI Index
Spaces method and path for this operation: post /s/{spaceid}/api/contextengine/aiindex Refer to Spaces for more information. Creates an AI Index record attached to a data stream or index. Fails with a 409 if an AI Index with the same ID already exists.
- Destructive
Create or update an AI Index
Spaces method and path for this operation: put /s/{spaceid}/api/contextengine/aiindex/{aiIndexId} Refer to Spaces for more information. Creates an AI Index with the given ID, or replaces an existing one.
- Destructive
Delete an AI Index
Spaces method and path for this operation: delete /s/{spaceid}/api/contextengine/aiindex/{aiIndexId} Refer to Spaces for more information. Deletes an AI Index by ID.
Dashboards
- Read
Search dashboards
This documentation is temporarily hosted at a separate location. View the full Dashboards API reference →
- Read
Get a dashboard
This documentation is temporarily hosted at a separate location. View the full Dashboards API reference →
- Write
Create a dashboard
This documentation is temporarily hosted at a separate location. View the full Dashboards API reference →
- Destructive
Upsert a dashboard
This documentation is temporarily hosted at a separate location. View the full Dashboards API reference →
- Destructive
Delete a dashboard
This documentation is temporarily hosted at a separate location. View the full Dashboards API reference →
Data views
- Read
Get all data views
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews Refer to Spaces for more information. Retrieve a list of all data views. Use this endpoint to identify available data views in the current Kibana space.
- Read
Get a data view
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews/dataview/{viewId} Refer to Spaces for more information. Retrieve a single data view by its identifier. Data views identify the Elasticsearch data you want to explore and visualize.
- Read
Get a runtime field
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews/dataview/{viewId}/runtimefield/{fieldName} Refer to Spaces for more information. Retrieve a single runtime field by name from a data view.
- Read
Get the default data view
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews/default Refer to Spaces for more information. Retrieve the identifier of the default data view for the current Kibana space.
- Read
Preview swap references
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/swapreferences/preview Refer to Spaces for more information. Preview the effect of swapping saved object references from one data view to another.
- Write
Create a data view
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/dataview Refer to Spaces for more information. Create a data view. Data views identify the Elasticsearch data you want to explore and visualize.
- Write
Update a data view
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/dataview/{viewId} Refer to Spaces for more information. Update an existing data view. Only the fields provided in the request body are updated.
- Write
Update field metadata
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/dataview/{viewId}/fields Refer to Spaces for more information. Update field metadata for a data view.
- Write
Create a runtime field
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/dataview/{viewId}/runtimefield Refer to Spaces for more information. Create a runtime field for a data view.
- Write
Update a runtime field
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/dataview/{viewId}/runtimefield/{fieldName} Refer to Spaces for more information. Update an existing runtime field in a data view. Only the fields provided in the request body are updated.
- Write
Set the default data view
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/default Refer to Spaces for more information. Set the default data view for the current Kibana space. The default data view is used as a fallback when no specific data view is selected.
- Write
Swap saved object references
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/swapreferences Refer to Spaces for more information. Swap saved object references from one data view to another.
- Destructive
Delete a data view
Spaces method and path for this operation: delete /s/{spaceid}/api/dataviews/dataview/{viewId} Refer to Spaces for more information. Delete a data view by its identifier. WARNING: When you delete a data view, it cannot be recovered.
- Destructive
Create or update a runtime field
Spaces method and path for this operation: put /s/{spaceid}/api/dataviews/dataview/{viewId}/runtimefield Refer to Spaces for more information. Create or update a runtime field for a data view. If the runtime field already exists, it is replaced with the new definition.
- Destructive
Delete a runtime field
Spaces method and path for this operation: delete /s/{spaceid}/api/dataviews/dataview/{viewId}/runtimefield/{fieldName} Refer to Spaces for more information. Delete a runtime field from a data view.
Data views v2
- Read
Search data views
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews/v2 Refer to Spaces for more information. Returns a paginated list of the data views in the current space. Each item includes only the name, index pattern, and time field.
- Read
Get a data view
Spaces method and path for this operation: get /s/{spaceid}/api/dataviews/v2/{id} Refer to Spaces for more information. Returns a data view by ID, including its field settings and runtime fields.
- Write
Create a data view
Spaces method and path for this operation: post /s/{spaceid}/api/dataviews/v2 Refer to Spaces for more information. Creates a data view and returns it. Kibana generates the data view ID. If a data view with the same name already exists, the request fails with a conflict.
- Destructive
Upsert a data view
Spaces method and path for this operation: put /s/{spaceid}/api/dataviews/v2/{id} Refer to Spaces for more information. Creates the data view with the ID in the path, or replaces its definition if it already exists.
- Destructive
Delete a data view
Spaces method and path for this operation: delete /s/{spaceid}/api/dataviews/v2/{id} Refer to Spaces for more information. Permanently deletes a data view by ID. You can't recover a deleted data view.
Security Detections API
- Read
Find and/or aggregate attack discovery alerts
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/attacks/search Refer to Spaces for more information. Find and/or aggregate attack discovery alerts that match the given query.
- Read
Reads the alert index name if it exists
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/index Refer to Spaces for more information. Returns the backing Elasticsearch index for Elastic Security detection alerts in the current space, and whether its mapping is outdated.
- Read
Returns user privileges for the Kibana space
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/privileges Refer to Spaces for more information.
- Read
Retrieve a detection rule
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/rules Refer to Spaces for more information. Retrieve a detection rule using the ruleid or id field.
- Read
Export detection rules
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules/export Refer to Spaces for more information. Export detection rules to an .ndjson file.
- Read
List all detection rules
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/rules/find Refer to Spaces for more information. Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page.
- Read
Retrieve the status of prebuilt detection rules and Timelines
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/rules/prepackaged/status Refer to Spaces for more information. Retrieve the status of all Elastic prebuilt detection rules and Timelines.
- Read
Preview rule alerts generated on specified time range
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules/preview Refer to Spaces for more information.
- Read
Find and/or aggregate detection alerts
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/signals/search Refer to Spaces for more information. Find and/or aggregate detection alerts that match the given query.
- Read
List all detection rule tags
Spaces method and path for this operation: get /s/{spaceid}/api/detectionengine/tags Refer to Spaces for more information. List all unique tags from all detection rules.
- Write
Assign and unassign users from attack discovery alerts
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/attacks/assignees Refer to Spaces for more information. Assign users to attack discovery alerts, and unassign them from alerts.
- Write
Set attack discovery alerts workflow status
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/attacks/status Refer to Spaces for more information. Set the workflow status of one or more attack discovery alerts by IDs, optionally cascading the status to their related detection alerts.
- Write
Add and remove attack discovery alert tags
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/attacks/tags Refer to Spaces for more information. Add tags to attack discovery alerts, and remove them from alerts, by attack IDs in a single request.
- Write
Create an alerts index
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/index Refer to Spaces for more information. Creates an index for Elastic Security alerts. Calling this API is not required for the detection engine to function properly.
- Write
Create a detection rule
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules Refer to Spaces for more information. Create a new detection rule. warn When used with API key authentication, the user's key gets assigned to the affected rules.
- Write
Patch a detection rule
Spaces method and path for this operation: patch /s/{spaceid}/api/detectionengine/rules Refer to Spaces for more information. Update specific fields of an existing detection rule using the ruleid or id field.
- Write
Apply a bulk action to detection rules
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules/bulkaction Refer to Spaces for more information. Apply a bulk action, such as bulk edit, duplicate, or delete, to multiple detection rules.
- Write
Import detection rules
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules/import Refer to Spaces for more information. Import detection rules from an .ndjson file, including actions and exception lists.
- Write
Assign and unassign users from detection alerts
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/signals/assignees Refer to Spaces for more information. Assign users to detection alerts, and unassign them from alerts. info You cannot add and remove the same assignee in the same request.
- Write
Set a detection alert status
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/signals/status Refer to Spaces for more information. Set the status of one or more detection alerts.
- Write
Add and remove detection alert tags
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/signals/tags Refer to Spaces for more information. Add tags to detection alerts, and remove them from alerts, by alert IDs or a query, in a single request.
- Destructive
Delete an alerts index
Spaces method and path for this operation: delete /s/{spaceid}/api/detectionengine/index Refer to Spaces for more information. Permanently deletes the Elastic Security alerts backing index in the current space, including the alerts stored in it.
- Destructive
Update a detection rule
Spaces method and path for this operation: put /s/{spaceid}/api/detectionengine/rules Refer to Spaces for more information. Update a detection rule using the ruleid or id field. The original rule is replaced, and all unspecified fields are deleted.
- Destructive
Delete a detection rule
Spaces method and path for this operation: delete /s/{spaceid}/api/detectionengine/rules Refer to Spaces for more information. Delete a detection rule using the ruleid or id field.
- Destructive
Install prebuilt detection rules and Timelines
Spaces method and path for this operation: put /s/{spaceid}/api/detectionengine/rules/prepackaged Refer to Spaces for more information. Install and update all Elastic prebuilt detection rules and Timelines.
Security Exceptions API
- Read
Get exception list details
Spaces method and path for this operation: get /s/{spaceid}/api/exceptionlists Refer to Spaces for more information. Get the details of an exception list using the id or listid field.
- Read
Export an exception list
Spaces method and path for this operation: post /s/{spaceid}/api/exceptionlists/export Refer to Spaces for more information. Export an exception list and its associated items to an NDJSON file.
- Read
Get exception lists
Spaces method and path for this operation: get /s/{spaceid}/api/exceptionlists/find Refer to Spaces for more information. Get a list of all exception list containers.
- Read
Get an exception list item
Spaces method and path for this operation: get /s/{spaceid}/api/exceptionlists/items Refer to Spaces for more information. Get the details of an exception list item using the id or itemid field.
- Read
Get exception list items
Spaces method and path for this operation: get /s/{spaceid}/api/exceptionlists/items/find Refer to Spaces for more information. Get a list of all exception list items in the specified list.
- Read
Get an exception list summary
Spaces method and path for this operation: get /s/{spaceid}/api/exceptionlists/summary Refer to Spaces for more information. Get a summary of the specified exception list.
- Write
Create rule exception items
Spaces method and path for this operation: post /s/{spaceid}/api/detectionengine/rules/{id}/exceptions Refer to Spaces for more information. Create exception items that apply to a single detection rule.
- Write
Create an exception list
Spaces method and path for this operation: post /s/{spaceid}/api/exceptionlists Refer to Spaces for more information. An exception list groups exception items and can be associated with detection rules. You can assign exception lists to multiple detection rules.
- Write
Duplicate an exception list
Spaces method and path for this operation: post /s/{spaceid}/api/exceptionlists/duplicate Refer to Spaces for more information. Duplicate an existing exception list.
- Write
Import an exception list
Spaces method and path for this operation: post /s/{spaceid}/api/exceptionlists/import Refer to Spaces for more information. Import an exception list and its associated items from an NDJSON file.
- Write
Create an exception list item
Spaces method and path for this operation: post /s/{spaceid}/api/exceptionlists/items Refer to Spaces for more information. Create an exception item and associate it with the specified exception list. info Before creating exception items, you must create an exception list.
- Destructive
Update an exception list
Spaces method and path for this operation: put /s/{spaceid}/api/exceptionlists Refer to Spaces for more information. Update an exception list using the id or listid field.
- Destructive
Delete an exception list
Spaces method and path for this operation: delete /s/{spaceid}/api/exceptionlists Refer to Spaces for more information. Delete an exception list using the id or listid field.
- Destructive
Update an exception list item
Spaces method and path for this operation: put /s/{spaceid}/api/exceptionlists/items Refer to Spaces for more information. Update an exception list item using the id or itemid field.
- Destructive
Delete an exception list item
Spaces method and path for this operation: delete /s/{spaceid}/api/exceptionlists/items Refer to Spaces for more information. Delete an exception list item using the id or itemid field.
Discover sessions
- Read
Search Discover sessions
Spaces method and path for this operation: get /s/{spaceid}/api/discoversessions Refer to Spaces for more information. Returns a paginated summary list of Discover sessions. Use GET /api/discoversessions/{id} for the full session state.
- Read
Get a Discover session
Spaces method and path for this operation: get /s/{spaceid}/api/discoversessions/{id} Refer to Spaces for more information. Returns the complete state of a Discover session by ID.
- Write
Create a Discover session
Spaces method and path for this operation: post /s/{spaceid}/api/discoversessions Refer to Spaces for more information. Creates a Discover session and returns its ID, full state, and metadata.
- Destructive
Upsert a Discover session
Spaces method and path for this operation: put /s/{spaceid}/api/discoversessions/{id} Refer to Spaces for more information. Creates a Discover session with the specified ID, or fully replaces the existing session.
- Destructive
Delete a Discover session
Spaces method and path for this operation: delete /s/{spaceid}/api/discoversessions/{id} Refer to Spaces for more information. Permanently deletes a Discover session by ID.
Saved objects
- Read
Export saved objects
Spaces method and path for this operation: post /s/{spaceid}/api/savedobjects/export Refer to Spaces for more information. Retrieve sets of saved objects that you want to import into Kibana. You must include type or objects in the request body.
- Write
Rotate a key for encrypted saved objects
Superuser role required. If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys.
- Write
Import saved objects
Spaces method and path for this operation: post /s/{spaceid}/api/savedobjects/import Refer to Spaces for more information. Create sets of Kibana saved objects from a file created by the export API.
- Write
Resolve import errors
Spaces method and path for this operation: post /s/{spaceid}/api/savedobjects/resolveimporterrors Refer to Spaces for more information.
Security Endpoint Exceptions API
- Read
Get an Elastic Endpoint rule exception list item
Spaces method and path for this operation: get /s/{spaceid}/api/endpointlist/items Refer to Spaces for more information. Get the details of an Elastic Endpoint exception list item, specified by the id or itemid field.
- Read
Get Elastic Endpoint exception list items
Spaces method and path for this operation: get /s/{spaceid}/api/endpointlist/items/find Refer to Spaces for more information. Get a list of all Elastic Endpoint exception list items.
- Write
Create an Elastic Endpoint rule exception list
Spaces method and path for this operation: post /s/{spaceid}/api/endpointlist Refer to Spaces for more information. Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a listid of endpointlist.
- Write
Create an Elastic Endpoint rule exception list item
Spaces method and path for this operation: post /s/{spaceid}/api/endpointlist/items Refer to Spaces for more information. Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list.
- Destructive
Update an Elastic Endpoint rule exception list item
Spaces method and path for this operation: put /s/{spaceid}/api/endpointlist/items Refer to Spaces for more information. Update an Elastic Endpoint exception list item, specified by the id or itemid field.
- Destructive
Delete an Elastic Endpoint exception list item
Spaces method and path for this operation: delete /s/{spaceid}/api/endpointlist/items Refer to Spaces for more information. Delete an Elastic Endpoint exception list item, specified by the id or itemid field.
Security Endpoint Management API
- Read
Get response actions
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/action Refer to Spaces for more information. Get a list of all response actions.
- Read
Get response actions status
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/actionstatus Refer to Spaces for more information. Get the status of response actions for the specified agent IDs.
- Read
Get action details
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/action/{actionid} Refer to Spaces for more information. Get the details of a response action using the action ID.
- Read
Get file information
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/action/{actionid}/file/{fileid} Refer to Spaces for more information. Get information for the specified response action file download.
- Read
Download a file
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/action/{actionid}/file/{fileid}/download Refer to Spaces for more information. Download a file associated with a response action.
- Read
Get a file
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/getfile Refer to Spaces for more information. Get a file from an endpoint.
- Read
Get running processes
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/runningprocs Refer to Spaces for more information. Get a list of all processes running on an endpoint.
- Read
Get actions state
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/action/state Refer to Spaces for more information. Get a response actions state, which reports whether encryption is enabled.
- Read
Get a metadata list
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/metadata Refer to Spaces for more information. Get a list of all endpoint host metadata.
- Read
Get metadata
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/metadata/{id} Refer to Spaces for more information. Get host metadata for a specific endpoint.
- Read
Get a policy response
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/policyresponse Refer to Spaces for more information. Get the most recent policy response for an endpoint.
- Read
Get a protection updates note
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/protectionupdatesnote/{packagepolicyid} Refer to Spaces for more information. Get the protection updates note for a package policy.
- Read
Get a list of scripts
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/scriptslibrary Refer to Spaces for more information. Retrieve a list of scripts
- Read
Get script
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/scriptslibrary/{scriptid} Refer to Spaces for more information. Get a script
- Read
Download a script file
Spaces method and path for this operation: get /s/{spaceid}/api/endpoint/scriptslibrary/{scriptid}/download Refer to Spaces for more information. Download a script file
- Write
Run a command
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/execute Refer to Spaces for more information. Run a shell command on an endpoint.
- Write
Isolate an endpoint
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/isolate Refer to Spaces for more information. Isolate an endpoint from the network. The endpoint remains isolated until it's released.
- Write
Terminate a process
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/killprocess Refer to Spaces for more information. Terminate a running process on an endpoint.
- Write
Generate a memory dump from the host machine
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/memorydump Refer to Spaces for more information. Generates memory dumps on the targeted host.
- Write
Run a script
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/runscript Refer to Spaces for more information. Run a script on a host. Currently supported only for some agent types.
- Write
Scan a file or directory
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/scan Refer to Spaces for more information. Scan a specific file or directory on an endpoint for malware.
- Write
Suspend a process
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/suspendprocess Refer to Spaces for more information. Suspend a running process on an endpoint.
- Write
Release an isolated endpoint
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/unisolate Refer to Spaces for more information. Release an isolated endpoint, allowing it to rejoin a network.
- Write
Upload a file
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/upload Refer to Spaces for more information. Upload a file to an endpoint.
- Write
Create or update a protection updates note
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/protectionupdatesnote/{packagepolicyid} Refer to Spaces for more information. Create or update the protection updates note for a package policy.
- Write
Create script
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/scriptslibrary Refer to Spaces for more information. Create a new script entry by uploading a script file
- Write
Update script
Spaces method and path for this operation: patch /s/{spaceid}/api/endpoint/scriptslibrary/{scriptid} Refer to Spaces for more information. Update (full or partial) a script entry
- Destructive
Cancel a response action
Spaces method and path for this operation: post /s/{spaceid}/api/endpoint/action/cancel Refer to Spaces for more information. Cancel a running or pending response action (Applies only to some agent types).
- Destructive
Delete a script
Spaces method and path for this operation: delete /s/{spaceid}/api/endpoint/scriptslibrary/{scriptid} Refer to Spaces for more information. Delete a script
Security Entity Analytics API
- Read
Gets the status of the privileged access detection package for the Entity Analytics privileged user monitoring experien…
Spaces method and path for this operation: get /s/{spaceid}/api/entityanalytics/privilegedusermonitoring/pad/status Refer to Spaces for more information.
- Read
Get a watchlist by ID
Spaces method and path for this operation: get /s/{spaceid}/api/entityanalytics/watchlists/{id} Refer to Spaces for more information. Retrieves the details of an entity analytics watchlist by its unique identifier.
- Read
List all watchlists
Spaces method and path for this operation: get /s/{spaceid}/api/entityanalytics/watchlists/list Refer to Spaces for more information. Returns a list of all entity analytics watchlists.
- Read
Get risk score history for an entity
Spaces method and path for this operation: get /s/{spaceid}/api/riskscore/history Refer to Spaces for more information. Returns time-ordered historical risk score entries from the risk score time-series index for a given entity.
- Write
Installs the privileged access detection package for the Entity Analytics privileged user monitoring experience
Spaces method and path for this operation: post /s/{spaceid}/api/entityanalytics/privilegedusermonitoring/pad/install Refer to Spaces for more information.
- Write
Create a new watchlist
Spaces method and path for this operation: post /s/{spaceid}/api/entityanalytics/watchlists Refer to Spaces for more information. Creates a new entity analytics watchlist with an optional set of entity sources. Watchlists apply a risk score modifier to matched entities.
- Write
Upload a CSV file to add entities to a watchlist
Spaces method and path for this operation: post /s/{spaceid}/api/entityanalytics/watchlists/{watchlistid}/csvupload Refer to Spaces for more information. Uploads a CSV file to add entities to a watchlist.
- Write
Manually assign entities to a watchlist
Spaces method and path for this operation: post /s/{spaceid}/api/entityanalytics/watchlists/{watchlistid}/entities/assign Refer to Spaces for more information. Assigns the provided entities to the specified watchlist using a "manual" source label.
- Write
Manually unassign entities from a watchlist
Spaces method and path for this operation: post /s/{spaceid}/api/entityanalytics/watchlists/{watchlistid}/entities/unassign Refer to Spaces for more information. Unassigns the provided entities from the specified watchlist. This only removes the "manual" assignment.
- Write
Configure the Risk Engine Saved Object
Spaces method and path for this operation: patch /s/{spaceid}/api/riskscore/engine/savedobject/configure Refer to Spaces for more information. Configuring the Risk Engine Saved Object
- Write
Run the risk scoring engine
Spaces method and path for this operation: post /s/{spaceid}/api/riskscore/engine/schedulenow Refer to Spaces for more information. Schedule the risk scoring engine to run as soon as possible.
- Destructive
Update an existing watchlist
Spaces method and path for this operation: put /s/{spaceid}/api/entityanalytics/watchlists/{id} Refer to Spaces for more information. Updates the name, description, risk modifier, or managed status of an existing entity analytics watchlist.
- Destructive
Cleanup the Risk Engine
Spaces method and path for this operation: delete /s/{spaceid}/api/riskscore/engine/dangerouslydeletedata Refer to Spaces for more information. Cleaning up the the Risk Engine by removing the indices, mapping and transforms
System
- Read
Get features
Get information about all Kibana features. Features are used by spaces and security to refine and secure access to Kibana.
- Read
Get Kibana's current status
Returns Kibana's overall operational status and a per-service breakdown for Elasticsearch, Saved Objects, and registered plugins. The endpoint is intended for liveness and readiness checks (for example, by Kubernetes probes) and for operators monitoring a Kibana deployment.
Elastic Agent binary download sources
- Read
Get agent binary download sources
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentdownloadsources Refer to Spaces for more information. List all agent binary download sources. [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-settings-read.
- Read
Get an agent binary download source
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentdownloadsources/{sourceId} Refer to Spaces for more information. Get an agent binary download source by ID.
- Write
Create an agent binary download source
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentdownloadsources Refer to Spaces for more information. Create a new agent binary download source. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Update an agent binary download source
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/agentdownloadsources/{sourceId} Refer to Spaces for more information. Update an agent binary download source by ID. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Delete an agent binary download source
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/agentdownloadsources/{sourceId} Refer to Spaces for more information. Delete an agent binary download source by ID. [Required authorization] Route required privileges: fleet-settings-all.
Elastic Agent policies
- Read
Get agent policies
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies Refer to Spaces for more information. List all agent policies. [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup.
- Read
Get an agent policy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId} Refer to Spaces for more information. Get an agent policy by ID.
- Read
Get auto upgrade agent status
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId}/autoupgradeagentsstatus Refer to Spaces for more information. Get the auto-upgrade status for agents assigned to an agent policy.
- Read
Download an agent policy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId}/download Refer to Spaces for more information. Download an agent policy by ID. [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-setup.
- Read
Get a full agent policy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId}/full Refer to Spaces for more information. Get a full agent policy by ID. [Required authorization] Route required privileges: fleet-agent-policies-read.
- Read
Get outputs for an agent policy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId}/outputs Refer to Spaces for more information. Get a list of outputs associated with agent policy by policy id.
- Read
Get outputs for agent policies
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentpolicies/outputs Refer to Spaces for more information. Get a list of outputs associated with agent policies.
- Read
Get a full K8s agent manifest
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/kubernetes Refer to Spaces for more information. Get the Kubernetes manifest for deploying Elastic Agent. [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-setup.
- Read
Download an agent manifest
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/kubernetes/download Refer to Spaces for more information. Download the Kubernetes manifest for deploying Elastic Agent.
- Write
Create an agent policy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentpolicies Refer to Spaces for more information. Create a new agent policy. [Required authorization] Route required privileges: fleet-agent-policies-all.
- Write
Bulk get agent policies
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentpolicies/bulkget Refer to Spaces for more information. Get multiple agent policies by ID.
- Write
Copy an agent policy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId}/copy Refer to Spaces for more information. Copy an agent policy by ID. [Required authorization] Route required privileges: fleet-agent-policies-all.
- Destructive
Update an agent policy
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/agentpolicies/{agentPolicyId} Refer to Spaces for more information. Update an agent policy by ID. [Required authorization] Route required privileges: fleet-agent-policies-all.
- Destructive
Delete an agent policy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentpolicies/delete Refer to Spaces for more information. Delete an agent policy by ID. [Required authorization] Route required privileges: fleet-agent-policies-all.
Elastic Agent status
- Read
Get an agent status summary
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentstatus Refer to Spaces for more information. Get a summary of agent statuses for a given agent policy.
Elastic Agents
- Read
Get incoming agent data
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentstatus/data Refer to Spaces for more information. Get the data streams that an agent is actively sending data to. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get agents
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents Refer to Spaces for more information. List agents, with optional filtering and pagination. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get agents by action ids
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents Refer to Spaces for more information. Retrieve agents associated with specific action IDs. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get an agent
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/{agentId} Refer to Spaces for more information. Get an agent by ID. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get an agent's effective config
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/{agentId}/effectiveconfig Refer to Spaces for more information. Get an agent's effective config by ID. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get agent uploads
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/{agentId}/uploads Refer to Spaces for more information. Get a list of files uploaded by a specific agent. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get available agent versions
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/availableversions Refer to Spaces for more information. Get a list of Elastic Agent versions available for upgrade. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get an uploaded file
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/files/{fileId}/{fileName} Refer to Spaces for more information. Get a file uploaded by an agent. [Required authorization] Route required privileges: fleet-agents-read.
- Read
Get agent setup info
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/setup Refer to Spaces for more information. Get the current Fleet setup status, including whether Fleet is ready to enroll agents and which requirements or optional features are missing.
- Read
Get agent tags
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/tags Refer to Spaces for more information. Get a list of all tags used across enrolled agents. [Required authorization] Route required privileges: fleet-agents-read.
- Write
Migrate a single agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/migrate Refer to Spaces for more information. Migrate a single agent to another cluster. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Change agent privilege level
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/privilegelevelchange Refer to Spaces for more information. Change the privilege level of a single agent to unprivileged.
- Write
Migrate multiple agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkmigrate Refer to Spaces for more information. Bulk migrate agents to another cluster. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk change agent privilege level
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkprivilegelevelchange Refer to Spaces for more information. Change multiple agents' privilege level to unprivileged. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Initiate Fleet setup
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/setup Refer to Spaces for more information. Initialize Fleet. This endpoint is used by Elastic Agents to trigger Fleet setup. Safe to call multiple times; subsequent calls are idempotent.
- Destructive
Update an agent by ID
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/agents/{agentId} Refer to Spaces for more information. Update an agent by ID. [Required authorization] Route required privileges: fleet-agents-all.
- Destructive
Delete an agent
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/agents/{agentId} Refer to Spaces for more information. Delete an agent by ID. [Required authorization] Route required privileges: fleet-agents-all.
- Destructive
Delete an uploaded file
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/agents/files/{fileId} Refer to Spaces for more information. Delete a file uploaded by an agent. [Required authorization] Route required privileges: fleet-agents-all.
Fleet agentless policies
- Read
Deprecated: Get managed integrations
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentlesspolicies Refer to Spaces for more information. Deprecated. Use GET /api/fleet/managedintegrations instead. List managed integrations
- Read
Deprecated: Get a managed integration
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agentlesspolicies/{policyId} Refer to Spaces for more information. Deprecated. Use GET /api/fleet/managedintegrations/{policyId} instead. Get a managed integration by ID
- Write
Deprecated: Create a managed integration
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentlesspolicies Refer to Spaces for more information. Deprecated. Use POST /api/fleet/managedintegrations instead. Create a managed integration
- Write
Deprecated: Bulk upgrade managed integrations
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentlesspolicies/upgrade Refer to Spaces for more information. Deprecated. Use POST /api/fleet/managedintegrations/upgrade instead.
- Write
Deprecated: Preview a managed integrations upgrade
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agentlesspolicies/upgrade/dryrun Refer to Spaces for more information. Deprecated. Use POST /api/fleet/managedintegrations/upgrade/dryrun instead.
- Destructive
Deprecated: Update a managed integration
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/agentlesspolicies/{policyId} Refer to Spaces for more information. Deprecated. Use PUT /api/fleet/managedintegrations/{policyId} instead. Update a managed integration by ID.
- Destructive
Deprecated: Delete a managed integration
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/agentlesspolicies/{policyId} Refer to Spaces for more information. Deprecated. Use DELETE /api/fleet/managedintegrations/{policyId} instead. Delete a managed integration
Elastic Agent actions
- Read
Get an agent action status
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/agents/actionstatus Refer to Spaces for more information. Get the current status of recent agent actions. [Required authorization] Route required privileges: fleet-agents-read.
- Write
Create an agent action
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/actions Refer to Spaces for more information. Create a new action for a specific agent. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Reassign an agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/reassign Refer to Spaces for more information. Reassign an agent to a different agent policy. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Request agent diagnostics
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/requestdiagnostics Refer to Spaces for more information. Request a diagnostics bundle from a specific agent. [Required authorization] Route required privileges: fleet-agents-read.
- Write
Restart an agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/restart Refer to Spaces for more information. Restart an Elastic Agent.
- Write
Rollback an agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/rollback Refer to Spaces for more information. Rollback an agent to the previous version. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Unenroll an agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/unenroll Refer to Spaces for more information. Unenroll a specific agent, optionally revoking its enrollment API key.
- Write
Upgrade an agent
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/upgrade Refer to Spaces for more information. Upgrade a specific agent to a newer version. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk reassign agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkreassign Refer to Spaces for more information. Reassign multiple agents to a different agent policy. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk remove OpAMP collectors
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkremovecollectors Refer to Spaces for more information. Remove multiple OpAMP collectors from the Fleet agents list. Marks the collectors as unenrolled.
- Write
Bulk request diagnostics from agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkrequestdiagnostics Refer to Spaces for more information. Request diagnostics bundles from multiple agents. [Required authorization] Route required privileges: fleet-agents-read.
- Write
Bulk restart agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkrestart Refer to Spaces for more information. Restart multiple Elastic Agents.
- Write
Bulk rollback agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkrollback Refer to Spaces for more information. Rollback multiple agents to the previous version. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk unenroll agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkunenroll Refer to Spaces for more information. Unenroll multiple agents, optionally revoking their enrollment API keys. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk update agent tags
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkupdateagenttags Refer to Spaces for more information. Add or remove tags across multiple agents. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk upgrade agents
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/bulkupgrade Refer to Spaces for more information. Upgrade multiple agents to a newer version, with optional rollout controls. [Required authorization] Route required privileges: fleet-agents-all.
- Destructive
Remove an OpAMP collector
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/{agentId}/removecollector Refer to Spaces for more information. Remove a specific OpAMP collector from the Fleet agents list. Marks the collector as unenrolled.
- Destructive
Cancel an agent action
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/agents/actions/{actionId}/cancel Refer to Spaces for more information. Cancel a pending action for a specific agent. [Required authorization] Route required privileges: fleet-agents-all.
Fleet internals
- Read
Check permissions
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/check-permissions Refer to Spaces for more information. Check whether the current user has the required permissions to use Fleet. Optionally verifies Fleet Server setup privileges.
- Read
Check Fleet Server health
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/healthcheck Refer to Spaces for more information. Check the health status of a Fleet Server instance by its host ID. Returns the server status and name if available.
- Read
Get settings
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/settings Refer to Spaces for more information. Get the global Fleet settings. [Required authorization] Route required privileges: fleet-settings-read.
- Read
Get space settings
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/spacesettings Refer to Spaces for more information. Get the Fleet settings for the current Kibana space.
- Write
Initiate Fleet setup
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/setup Refer to Spaces for more information. Initialize Fleet and create the necessary Elasticsearch resources for Fleet to operate. Safe to call multiple times (idempotent).
- Destructive
Update settings
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/settings Refer to Spaces for more information. Update the global Fleet settings. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Create space settings
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/spacesettings Refer to Spaces for more information. Create or update Fleet settings for the current Kibana space. [Required authorization] Route required privileges: fleet-settings-all.
Fleet cloud connectors
- Read
Get cloud connectors
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/cloudconnectors Refer to Spaces for more information. List all Fleet cloud connectors. [Required authorization] Route required privileges: fleet-agent-policies-read OR integrations-read.
- Read
Get cloud connector
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/cloudconnectors/{cloudConnectorId} Refer to Spaces for more information. Get a cloud connector by ID. [Required authorization] Route required privileges: fleet-agent-policies-read OR integrations-read.
- Read
Get cloud connector usage (package policies using the connector)
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/cloudconnectors/{cloudConnectorId}/usage Refer to Spaces for more information. Get a list of package policies that are using a given cloud connector.
- Write
Create cloud connector
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/cloudconnectors Refer to Spaces for more information. Create a new Fleet cloud connector. [Required authorization] Route required privileges: fleet-agent-policies-all OR integrations-all.
- Destructive
Update cloud connector
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/cloudconnectors/{cloudConnectorId} Refer to Spaces for more information. Update a cloud connector by ID. [Required authorization] Route required privileges: fleet-agent-policies-all OR integrations-all.
- Destructive
Delete cloud connector (supports force deletion)
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/cloudconnectors/{cloudConnectorId} Refer to Spaces for more information. Delete a cloud connector by ID. Use the force query parameter to delete even if package policies are still using it.
Fleet cloud onboarding deployments
- Read
Get cloud onboarding deployment
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/cloudonboardingdeployments/{id} Refer to Spaces for more information. Get a cloud onboarding deployment by ID.
- Read
Get cloud onboarding deployments by connector ID
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/cloudonboardingdeployments/connector/{connectorId} Refer to Spaces for more information. List all cloud onboarding deployments for a given connector ID.
- Write
Create cloud onboarding deployment
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/cloudonboardingdeployments Refer to Spaces for more information. Create a new Fleet cloud onboarding deployment.
- Destructive
Update cloud onboarding deployment
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/cloudonboardingdeployments/{id} Refer to Spaces for more information. Update a cloud onboarding deployment by ID.
- Destructive
Delete cloud onboarding deployment
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/cloudonboardingdeployments/{id} Refer to Spaces for more information. Delete a cloud onboarding deployment by ID.
Data streams
- Read
Get data streams
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/datastreams Refer to Spaces for more information. List all Fleet-managed data streams with metadata including package, namespace, size, and last activity.
- Read
Check if data streams have data
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/datastreams/data Refer to Spaces for more information. Check whether one or more data stream index patterns contain any documents indexed at or after the given start time.
- Read
Get data streams
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/datastreams Refer to Spaces for more information. Get a list of data streams created by installed integration packages.
Fleet enrollment API keys
- Read
Get enrollment API keys
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/enrollmentapikeys Refer to Spaces for more information. List all enrollment API keys. [Required authorization] Route required privileges: fleet-agents-all OR fleet-setup.
- Read
Get an enrollment API key
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/enrollmentapikeys/{keyId} Refer to Spaces for more information. Get an enrollment API key by ID. [Required authorization] Route required privileges: fleet-agents-all OR fleet-setup.
- Write
Create an enrollment API key
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/enrollmentapikeys Refer to Spaces for more information. Create an enrollment API key for a given agent policy. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Bulk revoke or delete enrollment API keys
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/enrollmentapikeys/bulkdelete Refer to Spaces for more information. Revoke or delete multiple enrollment API keys. [Required authorization] Route required privileges: fleet-agents-all.
- Destructive
Revoke or delete an enrollment API key
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/enrollmentapikeys/{keyId} Refer to Spaces for more information. Revoke or delete an enrollment API key by ID. Use forceDelete=true to remove the document.
Elastic Package Manager (EPM)
- Read
Get package categories
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/categories Refer to Spaces for more information. Get a list of integration categories. [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.
- Read
Get packages
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages Refer to Spaces for more information. Get a list of integration packages available in the registry.
- Read
Get Bulk rollback packages details
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/bulkrollback/{taskId} Refer to Spaces for more information. Get the status and results of a bulk package rollback operation.
- Read
Get Bulk uninstall packages details
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/bulkuninstall/{taskId} Refer to Spaces for more information. Get the status and results of a bulk package uninstall operation.
- Read
Get Bulk upgrade packages details
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/bulkupgrade/{taskId} Refer to Spaces for more information. Get the status and results of a bulk package upgrade operation.
- Read
Get a package
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/{pkgName} Refer to Spaces for more information. Get information about a package by name, returning the latest installed or available version.
- Read
Get a package
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion} Refer to Spaces for more information. Get information about a specific version of a package.
- Read
Get a package file
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath} Refer to Spaces for more information. Get the contents of a specific file from a package.
- Read
Get package dependencies
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/dependencies Refer to Spaces for more information. Get the list of packages that a specific package depends on.
- Read
Get package stats
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/{pkgName}/stats Refer to Spaces for more information. Get usage statistics for a specific package, such as the number of agent policies using it.
- Read
Get installed packages
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/installed Refer to Spaces for more information. Get a list of all currently installed integration packages.
- Read
Get a limited package list
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/packages/limited Refer to Spaces for more information. Get the list of packages that cannot be uninstalled (e.g. elasticagent, fleetserver).
- Read
Get an inputs template
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs Refer to Spaces for more information. Get an inputs template for a package, used to pre-populate package policy forms.
- Read
Get a package signature verification key ID
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/epm/verificationkeyid Refer to Spaces for more information. Get the GPG key ID used to verify the signatures of packages from the Elastic Package Registry.
- Write
Bulk get assets
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/bulkassets Refer to Spaces for more information. Retrieve multiple Kibana saved object assets by their IDs and types.
- Write
Create a custom integration
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/customintegrations Refer to Spaces for more information. Create a new custom integration package with user-defined data streams.
- Write
Install a package by upload
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages Refer to Spaces for more information. Install a package by uploading a .zip or .tar.gz archive (max 100MB).
- Write
Bulk install packages
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/bulk Refer to Spaces for more information. Install multiple packages from the Elastic Package Registry in a single request.
- Write
Bulk enable/disable namespace-level customization for packages
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/bulknamespacecustomization Refer to Spaces for more information. Enable or disable namespace-level index template customization for a list of packages in one call.
- Write
Bulk rollback packages
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/bulkrollback Refer to Spaces for more information. Rollback multiple packages to their previous versions.
- Write
Bulk uninstall packages
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/bulkuninstall Refer to Spaces for more information. Uninstall multiple packages in a single operation.
- Write
Bulk upgrade packages
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/bulkupgrade Refer to Spaces for more information. Upgrade multiple packages to their latest versions.
- Write
Install a package from the registry
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName} Refer to Spaces for more information. Install the latest version of a package from the Elastic Package Registry.
- Write
Install a package from the registry
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion} Refer to Spaces for more information. Install a specific version of a package from the Elastic Package Registry.
- Write
Install Kibana assets for a package
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/kibanaassets Refer to Spaces for more information. Install Kibana assets (dashboards, visualizations, etc.) for a specific package version.
- Write
Install Kibana alert rule for a package
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/ruleassets Refer to Spaces for more information. Install Kibana alert rule assets for a specific package version.
- Write
Authorize transforms
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize Refer to Spaces for more information. Reauthorize Elasticsearch transforms installed by a package with secondary authorization headers.
- Write
Review a pending policy upgrade for a package with deprecations
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/reviewupgrade Refer to Spaces for more information. Review and accept or reject a pending policy upgrade for a package that contains deprecations.
- Write
Rollback a package to previous version
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/epm/packages/{pkgName}/rollback Refer to Spaces for more information. Rollback a package to its previously installed version.
- Destructive
Update a custom integration
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/epm/customintegrations/{pkgName} Refer to Spaces for more information. Update the datasets of an existing custom integration package.
- Destructive
Update package settings
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/epm/packages/{pkgName} Refer to Spaces for more information. Update settings for a package, such as whether policies are kept up to date automatically.
- Destructive
Delete a package
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/epm/packages/{pkgName} Refer to Spaces for more information. Uninstall a package and remove all its assets.
- Destructive
Update package settings
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion} Refer to Spaces for more information. Update settings for a specific version of a package.
- Destructive
Delete a package
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion} Refer to Spaces for more information. Uninstall a specific version of a package and remove all its assets.
- Destructive
Delete assets for a package
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastreamassets Refer to Spaces for more information. Delete datastream assets for a specific package, by data stream name.
- Destructive
Delete Kibana assets for a package
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/kibanaassets Refer to Spaces for more information. Delete Kibana assets (dashboards, visualizations, etc.) for a specific package version.
Fleet Server hosts
- Read
Get Fleet Server hosts
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/fleetserverhosts Refer to Spaces for more information. List all Fleet Server hosts. [Required authorization] Route required privileges: fleet-agents-all OR fleet-settings-read.
- Read
Get a Fleet Server host
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/fleetserverhosts/{itemId} Refer to Spaces for more information. Get a Fleet Server host by ID. [Required authorization] Route required privileges: fleet-settings-read.
- Write
Create a Fleet Server host
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/fleetserverhosts Refer to Spaces for more information. Create a new Fleet Server host. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Update a Fleet Server host
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/fleetserverhosts/{itemId} Refer to Spaces for more information. Update a Fleet Server host by ID. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Delete a Fleet Server host
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/fleetserverhosts/{itemId} Refer to Spaces for more information. Delete a Fleet Server host by ID. [Required authorization] Route required privileges: fleet-settings-all.
Fleet outputs
- Read
Get outputs
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/outputs Refer to Spaces for more information. List all Fleet outputs. [Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read.
- Read
Get output
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/outputs/{outputId} Refer to Spaces for more information. Get output by ID. [Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read.
- Read
Get the latest output health
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/outputs/{outputId}/health Refer to Spaces for more information. Get the latest health status of an output by ID. [Required authorization] Route required privileges: fleet-settings-read.
- Write
Generate a Logstash API key
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/logstashapikeys Refer to Spaces for more information. Generate an API key for Logstash to use with a Fleet output. [Required authorization] Route required privileges: fleet-settings-all.
- Write
Create output
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/outputs Refer to Spaces for more information. Create a new Fleet output. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Update output
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/outputs/{outputId} Refer to Spaces for more information. Update output by ID. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Delete output
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/outputs/{outputId} Refer to Spaces for more information. Delete output by ID. [Required authorization] Route required privileges: fleet-settings-all.
Fleet managed integrations
- Read
Get managed integrations
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/managedintegrations Refer to Spaces for more information. List managed integrations
- Read
Preview a managed integrations upgrade
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/managedintegrations/upgrade/dryrun Refer to Spaces for more information. Preview upgrading multiple managed integrations without applying any change.
- Read
Get a managed integration
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/managedintegrations/{policyId} Refer to Spaces for more information. Get a managed integration by ID
- Write
Create a managed integration
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/managedintegrations Refer to Spaces for more information. Create a managed integration
- Write
Bulk upgrade managed integrations
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/managedintegrations/upgrade Refer to Spaces for more information. Upgrade multiple managed integrations to their installed package version, migrating each package policy's config onto the new schema.
- Destructive
Update a managed integration
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/managedintegrations/{policyId} Refer to Spaces for more information. Update a managed integration by ID.
- Destructive
Delete a managed integration
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/managedintegrations/{policyId} Refer to Spaces for more information. Delete a managed integration
Message Signing Service
- Write
Rotate a Fleet message signing key pair
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/messagesigningservice/rotatekeypair Refer to Spaces for more information. Rotate the key pair used by Fleet to sign messages sent to Elastic Agents.
Fleet package policies
- Read
Get package policies
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/packagepolicies Refer to Spaces for more information. List all package policies.
- Read
Get a package policy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/packagepolicies/{packagePolicyId} Refer to Spaces for more information. Get a package policy by ID.
- Write
Create a package policy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/packagepolicies Refer to Spaces for more information. Create a new package policy and assign it to an agent policy.
- Write
Bulk get package policies
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/packagepolicies/bulkget Refer to Spaces for more information. Get multiple package policies by ID.
- Write
Bulk delete package policies
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/packagepolicies/delete Refer to Spaces for more information. Delete multiple package policies by ID. [Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all.
- Write
Upgrade a package policy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/packagepolicies/upgrade Refer to Spaces for more information. Upgrade a package policy to a newer package version.
- Write
Dry run a package policy upgrade
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/packagepolicies/upgrade/dryrun Refer to Spaces for more information. Preview the changes that would be applied by upgrading a package policy to a newer package version.
- Destructive
Update a package policy
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/packagepolicies/{packagePolicyId} Refer to Spaces for more information. Update a package policy by ID.
- Destructive
Delete a package policy
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/packagepolicies/{packagePolicyId} Refer to Spaces for more information. Delete a package policy by ID.
Fleet proxies
- Read
Get proxies
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/proxies Refer to Spaces for more information. List all Fleet proxies. [Required authorization] Route required privileges: fleet-settings-read.
- Read
Get a proxy
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/proxies/{itemId} Refer to Spaces for more information. Get a proxy by ID. [Required authorization] Route required privileges: fleet-settings-read.
- Write
Create a proxy
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/proxies Refer to Spaces for more information. Create a new Fleet proxy. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Update a proxy
Spaces method and path for this operation: put /s/{spaceid}/api/fleet/proxies/{itemId} Refer to Spaces for more information. Update a proxy by ID. [Required authorization] Route required privileges: fleet-settings-all.
- Destructive
Delete a proxy
Spaces method and path for this operation: delete /s/{spaceid}/api/fleet/proxies/{itemId} Refer to Spaces for more information. Delete a proxy by ID [Required authorization] Route required privileges: fleet-settings-all.
Fleet remote synced integrations
- Read
Get remote synced integrations status by outputId
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/remotesyncedintegrations/{outputId}/remotestatus Refer to Spaces for more information. Get the synchronization status of remote integrations for a specific output by its ID.
- Read
Get remote synced integrations status
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/remotesyncedintegrations/status Refer to Spaces for more information. Get the synchronization status of all remote integrations across connected remote clusters.
Fleet service tokens
- Write
Create a service token
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/servicetokens Refer to Spaces for more information. Create a Fleet Server service token. The token is used to enroll Fleet Server instances with Kibana.
Fleet uninstall tokens
- Read
Get metadata for latest uninstall tokens
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/uninstalltokens Refer to Spaces for more information. List the metadata for the latest uninstall tokens per agent policy. [Required authorization] Route required privileges: fleet-agents-all.
- Read
Get a decrypted uninstall token
Spaces method and path for this operation: get /s/{spaceid}/api/fleet/uninstalltokens/{uninstallTokenId} Refer to Spaces for more information. Get one decrypted uninstall token by its ID. [Required authorization] Route required privileges: fleet-agents-all.
- Write
Rotate an uninstall token
Spaces method and path for this operation: post /s/{spaceid}/api/fleet/uninstalltokens/{agentPolicyId}/rotate Refer to Spaces for more information. Rotate the uninstall token for an agent policy. Only applicable to policies with tamper protection enabled.
Links
- Read
List links library items
Spaces method and path for this operation: get /s/{spaceid}/api/links Refer to Spaces for more information. Returns a paginated list of links library items. Each result includes title, description, and metadata. Use GET /api/links/{id} to retrieve the complete state.
- Read
Get a links library item by ID
Spaces method and path for this operation: get /s/{spaceid}/api/links/{id} Refer to Spaces for more information. Returns the complete state of a links library item by ID.
- Write
Create a links library item
Spaces method and path for this operation: post /s/{spaceid}/api/links Refer to Spaces for more information. Creates a new links library item and returns its ID, full state, and metadata.
- Destructive
Upsert links library item
Spaces method and path for this operation: put /s/{spaceid}/api/links/{id} Refer to Spaces for more information. Replaces the full state of a links library item. Partial updates are not supported.
- Destructive
Delete a links library item
Spaces method and path for this operation: delete /s/{spaceid}/api/links/{id} Refer to Spaces for more information. Permanently deletes a links library item by ID.
Security Lists API
- Read
Get value list details
Spaces method and path for this operation: get /s/{spaceid}/api/lists Refer to Spaces for more information. Get the details of a value list using the list ID.
- Read
Get value lists
Spaces method and path for this operation: get /s/{spaceid}/api/lists/find Refer to Spaces for more information. Get a paginated subset of value lists. By default, the first page is returned, with 20 results per page.
- Read
Get status of value list data streams
Spaces method and path for this operation: get /s/{spaceid}/api/lists/index Refer to Spaces for more information. Verify that .lists and .items data streams exist.
- Read
Get a value list item
Spaces method and path for this operation: get /s/{spaceid}/api/lists/items Refer to Spaces for more information. Get the details of a value list item.
- Read
Export value list items
Spaces method and path for this operation: post /s/{spaceid}/api/lists/items/export Refer to Spaces for more information. Export list item values from the specified value list.
- Read
Get value list items
Spaces method and path for this operation: get /s/{spaceid}/api/lists/items/find Refer to Spaces for more information. Get all value list items in the specified list.
- Read
Get value list privileges
Spaces method and path for this operation: get /s/{spaceid}/api/lists/privileges Refer to Spaces for more information.
- Write
Create a value list
Spaces method and path for this operation: post /s/{spaceid}/api/lists Refer to Spaces for more information. Create a new value list.
- Write
Patch a value list
Spaces method and path for this operation: patch /s/{spaceid}/api/lists Refer to Spaces for more information. Update specific fields of an existing list using the list id.
- Write
Create a value list item
Spaces method and path for this operation: post /s/{spaceid}/api/lists/items Refer to Spaces for more information. Create a value list item and associate it with the specified value list. All value list items in the same list must be the same type.
- Write
Patch a value list item
Spaces method and path for this operation: patch /s/{spaceid}/api/lists/items Refer to Spaces for more information. Update specific fields of an existing value list item using the item id.
- Write
Import value list items
Spaces method and path for this operation: post /s/{spaceid}/api/lists/items/import Refer to Spaces for more information. Import value list items from a TXT or CSV file. The maximum file size is 9 million bytes. You can import items to a new or existing list.
- Destructive
Update a value list
Spaces method and path for this operation: put /s/{spaceid}/api/lists Refer to Spaces for more information. Update a value list using the list id. The original list is replaced, and all unspecified fields are deleted. info You cannot modify the id value.
- Destructive
Delete a value list
Spaces method and path for this operation: delete /s/{spaceid}/api/lists Refer to Spaces for more information. Delete a value list using the list ID. info When you delete a list, all of its list items are also deleted.
- Destructive
Delete value list data streams
Spaces method and path for this operation: delete /s/{spaceid}/api/lists/index Refer to Spaces for more information. Delete the .lists and .items data streams.
- Destructive
Update a value list item
Spaces method and path for this operation: put /s/{spaceid}/api/lists/items Refer to Spaces for more information. Update a value list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted.
- Destructive
Delete a value list item
Spaces method and path for this operation: delete /s/{spaceid}/api/lists/items Refer to Spaces for more information. Delete a value list item using its id, or its listid and value fields.
Logstash
- Read
Get a Logstash pipeline
Get information for a centrally-managed Logstash pipeline. To use this API, you must have either the logstashadmin built-in role or a customized Logstash reader role.
- Read
Get all Logstash pipelines
Get a list of all centrally-managed Logstash pipelines. To use this API, you must have either the logstashadmin built-in role or a customized Logstash reader role. info Limit the number of pipelines to 10,000 or fewer.
- Destructive
Create or update a Logstash pipeline
Create a centrally-managed Logstash pipeline or update a pipeline. To use this API, you must have either the logstashadmin built-in role or a customized Logstash writer role.
- Destructive
Delete a Logstash pipeline
Delete a centrally-managed Logstash pipeline. If your Elasticsearch cluster is protected with basic authentication, you must have either the logstashadmin built-in role or a customized Logstash writer role.
Maintenance window
- Read
Search for a maintenance window.
Spaces method and path for this operation: get /s/{spaceid}/api/maintenancewindow/find Refer to Spaces for more information. [Required authorization] Route required privileges: read-maintenance-window.
- Read
Get maintenance window details.
Spaces method and path for this operation: get /s/{spaceid}/api/maintenancewindow/{id} Refer to Spaces for more information. [Required authorization] Route required privileges: read-maintenance-window.
- Write
Create a maintenance window.
Spaces method and path for this operation: post /s/{spaceid}/api/maintenancewindow Refer to Spaces for more information. [Required authorization] Route required privileges: write-maintenance-window.
- Write
Update a maintenance window.
Spaces method and path for this operation: patch /s/{spaceid}/api/maintenancewindow/{id} Refer to Spaces for more information. [Required authorization] Route required privileges: write-maintenance-window.
- Write
Unarchive a maintenance window.
Spaces method and path for this operation: post /s/{spaceid}/api/maintenancewindow/{id}/unarchive Refer to Spaces for more information. [Required authorization] Route required privileges: write-maintenance-window.
- Destructive
Delete a maintenance window.
Spaces method and path for this operation: delete /s/{spaceid}/api/maintenancewindow/{id} Refer to Spaces for more information. [Required authorization] Route required privileges: write-maintenance-window.
- Destructive
Archive a maintenance window.
Spaces method and path for this operation: post /s/{spaceid}/api/maintenancewindow/{id}/archive Refer to Spaces for more information. [Required authorization] Route required privileges: write-maintenance-window.
Markdowns
- Read
List markdown library items
Spaces method and path for this operation: get /s/{spaceid}/api/markdowns Refer to Spaces for more information. Returns a paginated list of markdown library items. Each result includes title, description, and metadata, but not the content.
- Read
Get a markdown library item by ID
Spaces method and path for this operation: get /s/{spaceid}/api/markdowns/{id} Refer to Spaces for more information. Returns the complete state of a markdown library item by ID.
- Write
Create a markdown library item
Spaces method and path for this operation: post /s/{spaceid}/api/markdowns Refer to Spaces for more information. Creates a new markdown library item and returns its ID, full state, and metadata.
- Destructive
Upsert a markdown library item
Spaces method and path for this operation: put /s/{spaceid}/api/markdowns/{id} Refer to Spaces for more information. Replaces the full state of a markdown library item. Partial updates are not supported.
- Destructive
Delete a markdown library item
Spaces method and path for this operation: delete /s/{spaceid}/api/markdowns/{id} Refer to Spaces for more information. Permanently deletes a markdown library item by ID.
Ml
- Read
Sync saved objects in the default space
Spaces method and path for this operation: get /s/{spaceid}/api/ml/savedobjects/sync Refer to Spaces for more information. Synchronizes Kibana saved objects for machine learning jobs and trained models in the default space.
- Write
Update jobs spaces
Spaces method and path for this operation: post /s/{spaceid}/api/ml/savedobjects/updatejobsspaces Refer to Spaces for more information. Update a list of jobs to add and/or remove them from given spaces.
- Write
Update trained models spaces
Spaces method and path for this operation: post /s/{spaceid}/api/ml/savedobjects/updatetrainedmodelsspaces Refer to Spaces for more information. Update a list of trained models to add and/or remove them from given spaces.
Security Timeline API
- Read
Get notes
Spaces method and path for this operation: get /s/{spaceid}/api/note Refer to Spaces for more information. Returns Security Timeline notes as saved objects. Query modes (mutually exclusive branches on the server): 1.
- Read
Get Timeline or Timeline template details
Spaces method and path for this operation: get /s/{spaceid}/api/timeline Refer to Spaces for more information. Get the details of an existing saved Timeline or Timeline template.
- Read
Get draft Timeline or Timeline template details
Spaces method and path for this operation: get /s/{spaceid}/api/timeline/draft Refer to Spaces for more information. Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned.
- Read
Export Timelines
Spaces method and path for this operation: post /s/{spaceid}/api/timeline/export Refer to Spaces for more information. Export Timelines as an NDJSON file.
- Read
Resolve a Timeline or Timeline template
Spaces method and path for this operation: get /s/{spaceid}/api/timeline/resolve Refer to Spaces for more information.
- Read
Get Timelines or Timeline templates
Spaces method and path for this operation: get /s/{spaceid}/api/timelines Refer to Spaces for more information. Get a list of all saved Timelines or Timeline templates.
- Write
Add or update a note
Spaces method and path for this operation: patch /s/{spaceid}/api/note Refer to Spaces for more information. Creates a new note or updates an existing one. Create: Send note and omit noteId to create a new saved object.
- Write
Pin/unpin an event
Spaces method and path for this operation: patch /s/{spaceid}/api/pinnedevent Refer to Spaces for more information. Pin/unpin an event to/from an existing Timeline.
- Write
Create a Timeline or Timeline template
Spaces method and path for this operation: post /s/{spaceid}/api/timeline Refer to Spaces for more information. Create a new Timeline or Timeline template.
- Write
Update a Timeline
Spaces method and path for this operation: patch /s/{spaceid}/api/timeline Refer to Spaces for more information. Update an existing Timeline.
- Write
Copies timeline or timeline template
Spaces method and path for this operation: post /s/{spaceid}/api/timeline/copy Refer to Spaces for more information. Copies and returns a timeline or timeline template.
- Write
Create a clean draft Timeline or Timeline template
Spaces method and path for this operation: post /s/{spaceid}/api/timeline/draft Refer to Spaces for more information. Create a clean draft Timeline or Timeline template for the current user.
- Write
Favorite a Timeline or Timeline template
Spaces method and path for this operation: patch /s/{spaceid}/api/timeline/favorite Refer to Spaces for more information. Favorite a Timeline or Timeline template for the current user.
- Write
Import Timelines
Spaces method and path for this operation: post /s/{spaceid}/api/timeline/import Refer to Spaces for more information. Import Timelines.
- Write
Install prepackaged Timelines
Spaces method and path for this operation: post /s/{spaceid}/api/timeline/prepackaged Refer to Spaces for more information. Install or update prepackaged Timelines.
- Destructive
Delete one or more notes
Spaces method and path for this operation: delete /s/{spaceid}/api/note Refer to Spaces for more information. Deletes notes by saved object ID. Send either noteId (single ID) or noteIds (array of IDs) in the JSON body.
- Destructive
Delete Timelines or Timeline templates
Spaces method and path for this operation: delete /s/{spaceid}/api/timeline Refer to Spaces for more information. Delete one or more Timelines or Timeline templates.
Observability ai assistant
- Write
Generate a chat completion
Spaces method and path for this operation: post /s/{spaceid}/api/observabilityaiassistant/chat/complete Refer to Spaces for more information. Create a new chat completion by using the Observability AI Assistant.
Security Osquery API
- Read
Get unified query history
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/history Refer to Spaces for more information. Get a unified, time-sorted history of live, rule-triggered, and scheduled osquery executions. The response uses cursor-based pagination.
- Read
Get live queries
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/livequeries Refer to Spaces for more information. Get a list of all live queries.
- Read
Get live query details
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/livequeries/{id} Refer to Spaces for more information. Get the details of a live query using the query ID.
- Read
Get live query results
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/livequeries/{id}/results/{actionId} Refer to Spaces for more information. Get the results of a live query using the query action ID.
- Read
Export live query results
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/livequeries/{id}/results/{actionId}/export Refer to Spaces for more information. Export the results of a live query action as a downloadable file.
- Read
Get packs
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/packs Refer to Spaces for more information. Get a list of all query packs.
- Read
Get pack details
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/packs/{id} Refer to Spaces for more information. Get the details of a query pack using the pack ID.
- Read
Get saved queries
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/savedqueries Refer to Spaces for more information. Get a list of all saved queries.
- Read
Get saved query details
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/savedqueries/{id} Refer to Spaces for more information. Get the details of a saved query using the query ID.
- Read
Get scheduled action results
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/scheduledresults/{scheduleId}/{executionCount} Refer to Spaces for more information.
- Read
Export scheduled query results
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/scheduledresults/{scheduleId}/{executionCount}/export Refer to Spaces for more information. Export all result rows for a specific scheduled query execution as a downloadable file.
- Read
Get scheduled query results
Spaces method and path for this operation: get /s/{spaceid}/api/osquery/scheduledresults/{scheduleId}/{executionCount}/results Refer to Spaces for more information. Get paginated query result rows (the actual osquery output data) for a specific scheduled query execution.
- Write
Create a live query
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/livequeries Refer to Spaces for more information. Create and run a live query.
- Write
Create a pack
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/packs Refer to Spaces for more information. Create a query pack.
- Write
Copy a pack
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/packs/{id}/copy Refer to Spaces for more information. Create a copy of a query pack with a unique name by appending a copy suffix. If the name already exists, a numeric suffix is added (e.g., copy2).
- Write
Create a saved query
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/savedqueries Refer to Spaces for more information. Create and save a query for later use.
- Write
Copy a saved query
Spaces method and path for this operation: post /s/{spaceid}/api/osquery/savedqueries/{id}/copy Refer to Spaces for more information. Create a copy of a saved query with a unique name by appending a copy suffix.
- Destructive
Update a pack
Spaces method and path for this operation: put /s/{spaceid}/api/osquery/packs/{id} Refer to Spaces for more information. Update a query pack using the pack ID. info You cannot update a prebuilt pack.
- Destructive
Delete a pack
Spaces method and path for this operation: delete /s/{spaceid}/api/osquery/packs/{id} Refer to Spaces for more information. Delete a query pack using the pack ID.
- Destructive
Update a saved query
Spaces method and path for this operation: put /s/{spaceid}/api/osquery/savedqueries/{id} Refer to Spaces for more information. Update a saved query using the query ID. info You cannot update a prebuilt saved query.
- Destructive
Delete a saved query
Spaces method and path for this operation: delete /s/{spaceid}/api/osquery/savedqueries/{id} Refer to Spaces for more information. Delete a saved query using the query ID.
Universal Profiling
- Read
Get Universal Profiling setup status
Spaces method and path for this operation: get /s/{spaceid}/api/profiling/setup/esresources Refer to Spaces for more information. Check if Universal Profiling has been set up and configured properly [Required authorization] Route required privileges: profiling.
- Write
Initialize Universal Profiling setup
Spaces method and path for this operation: post /s/{spaceid}/api/profiling/setup/esresources Refer to Spaces for more information. Set up Universal Profiling resources and configuration [Required authorization] Route required privileges: profiling.
Security AI Assistant API
- Read
Get anonymization fields
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/anonymizationfields/find Refer to Spaces for more information. Get a list of all anonymization fields.
- Read
Get conversations
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/currentuser/conversations/find Refer to Spaces for more information. Get a list of all conversations for the current user.
- Read
Get a conversation
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/currentuser/conversations/{id} Refer to Spaces for more information. Get the details of an existing conversation using the conversation ID.
- Read
Read a KnowledgeBase
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/knowledgebase Refer to Spaces for more information. Read a single KB
- Read
Read a KnowledgeBase for a resource
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/knowledgebase/{resource} Refer to Spaces for more information. Read a knowledge base with a specific resource identifier.
- Read
Finds Knowledge Base Entries that match the given query.
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/knowledgebase/entries/find Refer to Spaces for more information. Finds Knowledge Base Entries that match the given query.
- Read
Read a Knowledge Base Entry
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/knowledgebase/entries/{id} Refer to Spaces for more information. Retrieve a Knowledge Base Entry by its unique id.
- Read
Get prompts
Spaces method and path for this operation: get /s/{spaceid}/api/securityaiassistant/prompts/find Refer to Spaces for more information. Get a list of all prompts based on optional filters, sorting, and pagination.
- Write
Apply a bulk action to anonymization fields
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/anonymizationfields/bulkaction Refer to Spaces for more information. Apply a bulk action to multiple anonymization fields.
- Write
Create a model response
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/chat/complete Refer to Spaces for more information. Create a model response for the given chat conversation.
- Write
Create a conversation
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/currentuser/conversations Refer to Spaces for more information. Create a new Security AI Assistant conversation.
- Write
Create a KnowledgeBase
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/knowledgebase Refer to Spaces for more information. Create a knowledge base. Use this endpoint when no specific resource identifier is needed.
- Write
Create a KnowledgeBase for a resource
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/knowledgebase/{resource} Refer to Spaces for more information. Create a knowledge base with a specific resource identifier.
- Write
Create a Knowledge Base Entry
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/knowledgebase/entries Refer to Spaces for more information. Create a Knowledge Base Entry
- Write
Applies a bulk action to multiple Knowledge Base Entries
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/knowledgebase/entries/bulkaction Refer to Spaces for more information.
- Write
Apply a bulk action to prompts
Spaces method and path for this operation: post /s/{spaceid}/api/securityaiassistant/prompts/bulkaction Refer to Spaces for more information. Apply a bulk action to multiple prompts.
- Destructive
Delete conversations
Spaces method and path for this operation: delete /s/{spaceid}/api/securityaiassistant/currentuser/conversations Refer to Spaces for more information. This endpoint allows users to permanently delete all conversations.
- Destructive
Update a conversation
Spaces method and path for this operation: put /s/{spaceid}/api/securityaiassistant/currentuser/conversations/{id} Refer to Spaces for more information. Update an existing conversation using the conversation ID.
- Destructive
Delete a conversation
Spaces method and path for this operation: delete /s/{spaceid}/api/securityaiassistant/currentuser/conversations/{id} Refer to Spaces for more information. Delete an existing conversation using the conversation ID.
- Destructive
Update a Knowledge Base Entry
Spaces method and path for this operation: put /s/{spaceid}/api/securityaiassistant/knowledgebase/entries/{id} Refer to Spaces for more information. Update an existing Knowledge Base Entry by its unique id.
- Destructive
Deletes a single Knowledge Base Entry using the id field
Spaces method and path for this operation: delete /s/{spaceid}/api/securityaiassistant/knowledgebase/entries/{id} Refer to Spaces for more information. Delete a Knowledge Base Entry by its unique id.
Security Solution Initialization API
- Write
Initialize security solution flows
Spaces method and path for this operation: post /s/{spaceid}/api/securitysolution/initialize Refer to Spaces for more information. Run one or more Security Solution initialization flows for the current space.
Security entity store
- Read
List entities
Spaces method and path for this operation: get /s/{spaceid}/api/security/entitystore/entities Refer to Spaces for more information. List entity records from the Entity Store with paging, sorting, and filtering.
- Read
Get resolution group
Spaces method and path for this operation: get /s/{spaceid}/api/security/entitystore/resolution/group Refer to Spaces for more information. Get the resolution group for a given entity, returning all linked entities.
- Read
List entity resolution rules
Spaces method and path for this operation: get /s/{spaceid}/api/security/entitystore/resolution/rules Refer to Spaces for more information. List managed entity resolution rules and their effective enabled state for this space.
- Read
Get Entity Store status
Spaces method and path for this operation: get /s/{spaceid}/api/security/entitystore/status Refer to Spaces for more information. Get the overall Entity Store status and per-engine statuses, optionally including component-level health details.
- Write
Create an entity
Spaces method and path for this operation: post /s/{spaceid}/api/security/entitystore/entities/{entityType} Refer to Spaces for more information. Create a new entity record in the Entity Store for the specified entity type.
- Write
Install the Entity Store
Spaces method and path for this operation: post /s/{spaceid}/api/security/entitystore/install Refer to Spaces for more information. Install the Entity Store and create engines for the specified entity types.
- Write
Link entities
Spaces method and path for this operation: post /s/{spaceid}/api/security/entitystore/resolution/link Refer to Spaces for more information. Link one or more entities to a target entity, creating a resolution group.
- Write
Unlink entities
Spaces method and path for this operation: post /s/{spaceid}/api/security/entitystore/resolution/unlink Refer to Spaces for more information. Remove one or more entities from their resolution group.
- Write
Uninstall the Entity Store
Spaces method and path for this operation: post /s/{spaceid}/api/security/entitystore/uninstall Refer to Spaces for more information. Uninstall the Entity Store, removing engines and associated resources for the specified entity types.
- Destructive
Update the Entity Store
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore Refer to Spaces for more information. Update the Entity Store configuration without reinstalling. Send logExtraction to change log extraction settings.
- Destructive
Delete an entity
Spaces method and path for this operation: delete /s/{spaceid}/api/security/entitystore/entities/ Refer to Spaces for more information. Delete a single entity record from the Entity Store. The entity is immediately removed from the latest index.
- Destructive
Update an entity
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/entities/{entityType} Refer to Spaces for more information. Update an existing entity record in the Entity Store. By default only certain fields can be updated.
- Destructive
Bulk update entities
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/entities/bulk Refer to Spaces for more information. Update multiple entity records in the Entity Store in a single request.
- Destructive
Disable the history snapshot task
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/historysnapshot/disable Refer to Spaces for more information. Disable the Entity Store history snapshot task for this space so it no longer creates snapshot indices.
- Destructive
Enable the history snapshot task
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/historysnapshot/enable Refer to Spaces for more information. Enable the Entity Store history snapshot task for this space.
- Destructive
Disable an entity resolution rule
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/resolution/rules/{id}/disable Refer to Spaces for more information. Disable a managed entity resolution rule in this space.
- Destructive
Enable an entity resolution rule
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/resolution/rules/{id}/enable Refer to Spaces for more information. Enable a managed entity resolution rule in this space.
- Destructive
Start Entity Store engines
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/start Refer to Spaces for more information. Start previously stopped entity engines, resuming data processing for the specified entity types.
- Destructive
Stop Entity Store engines
Spaces method and path for this operation: put /s/{spaceid}/api/security/entitystore/stop Refer to Spaces for more information. Stop running entity engines, pausing data processing for the specified entity types.
Roles
- Read
Get all roles
Retrieve all Kibana roles.
- Read
Get a role
Retrieve a Kibana role by its name.
- Write
Create or update roles
Create or update multiple Kibana roles in a single request.
- Destructive
Create or update a role
Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.
- Destructive
Delete a role
Delete a Kibana role by its name.
Security
- Read
Query roles
Query Kibana roles with optional filters, paging, and sorting.
User session
- Write
Invalidate user sessions
Invalidate user sessions that match a query. To use this API, you must be a superuser.
Short url
- Read
Resolve a short URL
Resolve a Kibana short URL by its slug.
- Read
Get a short URL
Get a single Kibana short URL.
- Write
Create a short URL
Kibana URLs may be long and cumbersome, short URLs are much easier to remember and share. Short URLs are created by specifying the locator ID and locator parameters.
- Destructive
Delete a short URL
Delete a Kibana short URL.
Spaces
- Read
Get all spaces
Retrieve all available Kibana spaces. The list includes only the spaces that the user is authorized to access.
- Read
Get a space
Retrieve a single Kibana space by its identifier.
- Write
Copy saved objects between spaces
It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved Discover sessions, as required.
- Write
Disable legacy URL aliases
Disable one or more legacy URL aliases so that they no longer resolve to their target saved objects.
- Write
Resolve conflicts copying saved objects
Overwrite saved objects that are returned as errors from the copy saved objects to space API. [Required authorization] Route required privileges: copySavedObjectsToSpaces.
- Write
Update saved objects in spaces
Update one or more saved objects to add or remove them from some spaces.
- Write
Create a space
Create a new Kibana space.
- Destructive
Update a space
Update an existing Kibana space.
- Destructive
Delete a space
When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
Streams
- Read
Get stream list
Spaces method and path for this operation: get /s/{spaceid}/api/streams Refer to Spaces for more information. Fetches list of all streams [Required authorization] Route required privileges: readstream.
- Read
Get a stream
Spaces method and path for this operation: get /s/{spaceid}/api/streams/{name} Refer to Spaces for more information. Fetches a stream definition and associated dashboards [Required authorization] Route required privileges: readstream.
- Read
Get ingest stream settings
Spaces method and path for this operation: get /s/{spaceid}/api/streams/{name}/ingest Refer to Spaces for more information. Fetches the ingest settings of an ingest stream definition [Required authorization] Route required privileges: readstream.
- Read
Get query stream settings
Spaces method and path for this operation: get /s/{spaceid}/api/streams/{name}/query Refer to Spaces for more information. Fetches the query settings of a query stream definition [Required authorization] Route required privileges: readstream.
- Read
Export stream content
Spaces method and path for this operation: post /s/{spaceid}/api/streams/{name}/content/export Refer to Spaces for more information. Exports a content pack with the stream structure (routing, mappings, and processing). Significant-event queries are not included.
- Read
Get stream attachments
Spaces method and path for this operation: get /s/{spaceid}/api/streams/{streamName}/attachments Refer to Spaces for more information. Fetches all attachments linked to a stream that are visible to the current user in the current space.
- Write
Disable streams
Spaces method and path for this operation: post /s/{spaceid}/api/streams/disable Refer to Spaces for more information. Disables wired streams and deletes all existing stream definitions. The data of wired streams is deleted, but the data of classic streams is preserved.
- Write
Enable streams
Spaces method and path for this operation: post /s/{spaceid}/api/streams/enable Refer to Spaces for more information. Enables wired streams [Required authorization] Route required privileges: managestream.
- Write
Resync streams
Spaces method and path for this operation: post /s/{spaceid}/api/streams/resync Refer to Spaces for more information. Resyncs all streams, making sure that Elasticsearch assets are up to date [Required authorization] Route required privileges: managestream.
- Write
Fork a stream
Spaces method and path for this operation: post /s/{spaceid}/api/streams/{name}/fork Refer to Spaces for more information. Forks a wired stream and creates a child stream [Required authorization] Route required privileges: managestream.
- Write
Import content into a stream
Spaces method and path for this operation: post /s/{spaceid}/api/streams/{name}/content/import Refer to Spaces for more information. Imports stream structure (routing, mappings, and processing) from a content pack into a stream.
- Write
Bulk update attachments
Spaces method and path for this operation: post /s/{spaceid}/api/streams/{streamName}/attachments/bulk Refer to Spaces for more information. Bulk update attachments linked to a stream. Can link new attachments and delete existing ones.
- Destructive
Create or update a stream
Spaces method and path for this operation: put /s/{spaceid}/api/streams/{name} Refer to Spaces for more information. Creates or updates a stream definition.
- Destructive
Delete a stream
Spaces method and path for this operation: delete /s/{spaceid}/api/streams/{name} Refer to Spaces for more information. Deletes a stream definition and the underlying data stream [Required authorization] Route required privileges: managestream.
- Destructive
Update ingest stream settings
Spaces method and path for this operation: put /s/{spaceid}/api/streams/{name}/ingest Refer to Spaces for more information. Upserts the ingest settings of an ingest stream definition [Required authorization] Route required privileges: managestream.
- Destructive
Upsert query stream settings
Spaces method and path for this operation: put /s/{spaceid}/api/streams/{name}/query Refer to Spaces for more information. Upserts the query settings of a query stream definition [Required authorization] Route required privileges: managestream.
- Destructive
Link an attachment to a stream
Spaces method and path for this operation: put /s/{spaceid}/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId} Refer to Spaces for more information. Links an attachment to a stream. Noop if the attachment is already linked to the stream.
- Destructive
Unlink an attachment from a stream
Spaces method and path for this operation: delete /s/{spaceid}/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId} Refer to Spaces for more information. Unlinks an attachment from a stream. Noop if the attachment is not linked to the stream.
Synthetics
- Read
Search monitors
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/monitors Refer to Spaces for more information. Get a list of monitors. You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.
- Read
Get a monitor
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/monitors/{id} Refer to Spaces for more information. Get a monitor by its config ID.
- Read
Search parameters
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/params Refer to Spaces for more information. Get a list of all parameters. You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.
- Read
Get a parameter
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/params/{id} Refer to Spaces for more information. Get a parameter from the Synthetics app.
- Read
Get private locations
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/privatelocations Refer to Spaces for more information. Get a list of private locations.
- Read
Get a private location
Spaces method and path for this operation: get /s/{spaceid}/api/synthetics/privatelocations/{id} Refer to Spaces for more information. You must have read privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.
- Write
Trigger an on-demand test run for a monitor
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/monitor/test/{monitorId} Refer to Spaces for more information. Trigger an immediate test execution for the specified monitor. The response includes the generated testRunId.
- Write
Create a monitor
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/monitors Refer to Spaces for more information. Create a new monitor with the specified attributes. A monitor can be one of the following types: HTTP, TCP, ICMP, or Browser.
- Write
Bulk create monitors
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/monitors/bulkcreate Refer to Spaces for more information. Create up to 1000 monitors in one request. Every monitor is validated before any monitor is persisted.
- Write
Add parameters
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/params Refer to Spaces for more information. Add one or more parameters to the Synthetics app.
- Write
Create a private location
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/privatelocations Refer to Spaces for more information. Create a private location backed by a Fleet agent policy.
- Destructive
Delete monitors
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/monitors/bulkdelete Refer to Spaces for more information. Delete multiple monitors by sending a list of config IDs. [Required authorization] Route required privileges: uptime-read AND uptime-write.
- Destructive
Bulk update monitors
Spaces method and path for this operation: put /s/{spaceid}/api/synthetics/monitors/bulkupdate Refer to Spaces for more information. Partially update multiple monitors in a single request.
- Destructive
Update a monitor
Spaces method and path for this operation: put /s/{spaceid}/api/synthetics/monitors/{id} Refer to Spaces for more information. Update a monitor with the specified attributes. The required and default fields may vary based on the monitor type.
- Destructive
Delete a monitor
Spaces method and path for this operation: delete /s/{spaceid}/api/synthetics/monitors/{id} Refer to Spaces for more information. Delete a monitor from the Synthetics app.
- Destructive
Delete parameters
Spaces method and path for this operation: post /s/{spaceid}/api/synthetics/params/bulkdelete Refer to Spaces for more information. Delete parameters from the Synthetics app.
- Destructive
Update a parameter
Spaces method and path for this operation: put /s/{spaceid}/api/synthetics/params/{id} Refer to Spaces for more information. Update a parameter in the Synthetics app.
- Destructive
Delete a parameter
Spaces method and path for this operation: delete /s/{spaceid}/api/synthetics/params/{id} Refer to Spaces for more information. Delete a parameter from the Synthetics app.
- Destructive
Update a private location
Spaces method and path for this operation: put /s/{spaceid}/api/synthetics/privatelocations/{id} Refer to Spaces for more information. Update an existing private location's label, tags, or agent policy.
- Destructive
Delete a private location
Spaces method and path for this operation: delete /s/{spaceid}/api/synthetics/privatelocations/{id} Refer to Spaces for more information. You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.
Tags
- Read
Search tags
Spaces method and path for this operation: get /s/{spaceid}/api/tags Refer to Spaces for more information. Returns a paginated list of tags matching the optional query text.
- Read
Get a tag
Spaces method and path for this operation: get /s/{spaceid}/api/tags/{id} Refer to Spaces for more information. Returns a tag by ID.
- Write
Create a tag
Spaces method and path for this operation: post /s/{spaceid}/api/tags Refer to Spaces for more information. Creates a new tag and returns it.
- Destructive
Upsert a tag
Spaces method and path for this operation: put /s/{spaceid}/api/tags/{id} Refer to Spaces for more information. Updates a tag if it exists, or creates it at the provided ID.
- Destructive
Delete a tag
Spaces method and path for this operation: delete /s/{spaceid}/api/tags/{id} Refer to Spaces for more information. Permanently deletes a tag by ID.
Task manager
- Read
Get the task manager health
Get the health status of the Kibana task manager.
Upgrade
- Read
Get the upgrade readiness status
Check the status of your cluster.
Uptime
- Read
Get uptime settings
Spaces method and path for this operation: get /s/{spaceid}/api/uptime/settings Refer to Spaces for more information. You must have read privileges for the uptime feature in the Observability section of the Kibana feature privileges.
- Destructive
Update uptime settings
Spaces method and path for this operation: put /s/{spaceid}/api/uptime/settings Refer to Spaces for more information. Update uptime setting attributes like heartbeatIndices, certExpirationThreshold, certAgeThreshold, defaultConnectors, or defaultEmail.
Visualizations
- Read
Search visualizations
This documentation is temporarily hosted at a separate location. View the full Visualizations API reference →
- Read
Get visualization
This documentation is temporarily hosted at a separate location. View the full Visualizations API reference →
- Write
Create visualization
This documentation is temporarily hosted at a separate location. View the full Visualizations API reference →
- Destructive
Upsert visualization
This documentation is temporarily hosted at a separate location. View the full Visualizations API reference →
- Destructive
Delete visualization
This documentation is temporarily hosted at a separate location. View the full Visualizations API reference →
Workflows
- Read
Get workflows
Spaces method and path for this operation: get /s/{spaceid}/api/workflows Refer to Spaces for more information. Retrieve a paginated list of workflows with optional filtering. [Required authorization] Route required privileges: workflowsManagement:read.
- Read
Get workflow aggregations
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/aggs Refer to Spaces for more information. Retrieve distinct values and their counts for the specified workflow fields. Useful for building filters such as lists of tags or creators.
- Read
Get available connectors
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/connectors Refer to Spaces for more information. Retrieve the Kibana action connectors that can be used in workflow steps, grouped by connector type.
- Read
Get a workflow execution
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId} Refer to Spaces for more information. Retrieve details of a single workflow execution by its ID.
- Read
Get child executions
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/children Refer to Spaces for more information. Retrieve child workflow executions spawned by sub-workflow steps within a parent execution.
- Read
Get execution logs
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/logs Refer to Spaces for more information. Retrieve paginated logs for a workflow execution. Optionally filter by a specific step execution.
- Read
Get a step execution
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/step/{stepExecutionId} Refer to Spaces for more information. Retrieve details of a single step execution within a workflow execution.
- Read
Get execution step executions
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/steps Refer to Spaces for more information. Retrieve a paginated list of step executions for a specific workflow execution.
- Read
Resume a workflow execution from an external link
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external Refer to Spaces for more information.
- Read
Get the external input form for a paused workflow execution
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external/form Refer to Spaces for more information. Returns an HTML form for submitting external input to a paused waitForInput step.
- Read
Export workflows
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/export Refer to Spaces for more information. Export one or more workflows as JSON with YAML content and metadata.
- Read
Get workflows by IDs
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/mget Refer to Spaces for more information. Retrieve multiple workflows by their IDs in a single request.
- Read
Get workflow JSON schema
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/schema Refer to Spaces for more information. Retrieve the JSON schema used to validate workflow YAML definitions.
- Read
Get workflow statistics
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/stats Refer to Spaces for more information.
- Read
Get a workflow
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/workflow/{id} Refer to Spaces for more information. Retrieve a single workflow by its ID.
- Read
Get workflow executions
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/workflow/{workflowId}/executions Refer to Spaces for more information. Retrieve a paginated list of executions for a specific workflow.
- Read
Get workflow step executions
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/workflow/{workflowId}/executions/steps Refer to Spaces for more information. Retrieve a paginated list of step-level execution records for a specific workflow.
- Read
Search workflow executions
Spaces method and path for this operation: get /s/{spaceid}/api/workflows/workflow/executions Refer to Spaces for more information. Search across all workflow executions.
- Write
Bulk create workflows
Spaces method and path for this operation: post /s/{spaceid}/api/workflows Refer to Spaces for more information. Create multiple workflows in a single request. Optionally overwrite existing workflows.
- Write
Resume a workflow execution
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/executions/{executionId}/resume Refer to Spaces for more information. Resume a paused workflow execution with the provided input.
- Write
Submit external input for a paused workflow execution
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external Refer to Spaces for more information. Resume a workflow execution that is paused and waiting for external input.
- Write
Test a workflow step
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/step/test Refer to Spaces for more information. Execute a single step from a workflow definition in test mode. [Required authorization] Route required privileges: workflowsManagement:execute.
- Write
Test a workflow
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/test Refer to Spaces for more information. Execute a workflow in test mode without requiring it to be saved or enabled.
- Write
Create a workflow
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/workflow Refer to Spaces for more information. Create a new workflow from a YAML definition. The YAML is validated and parsed before the workflow is saved. An optional custom ID can be provided.
- Write
Clone a workflow
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/workflow/{id}/clone Refer to Spaces for more information. Create a copy of an existing workflow.
- Write
Run a workflow
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/workflow/{id}/run Refer to Spaces for more information. Execute a workflow by its ID with the provided inputs. The workflow must be enabled and have a valid definition.
- Destructive
Bulk delete workflows
Spaces method and path for this operation: delete /s/{spaceid}/api/workflows Refer to Spaces for more information. Delete multiple workflows by their IDs. [Required authorization] Route required privileges: workflowsManagement:delete.
- Destructive
Cancel a workflow execution
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/executions/{executionId}/cancel Refer to Spaces for more information. Cancel a running workflow execution by its ID.
- Destructive
Update a managed workflow
Spaces method and path for this operation: put /s/{spaceid}/api/workflows/managed/workflow/{id} Refer to Spaces for more information. Partially update an existing managed workflow. This elevated route can update fields beyond the enabled state.
- Destructive
Update a workflow
Spaces method and path for this operation: put /s/{spaceid}/api/workflows/workflow/{id} Refer to Spaces for more information. Partially update an existing workflow.
- Destructive
Delete a workflow
Spaces method and path for this operation: delete /s/{spaceid}/api/workflows/workflow/{id} Refer to Spaces for more information. Delete a single workflow by its ID. [Required authorization] Route required privileges: workflowsManagement:delete.
- Destructive
Cancel all active workflow executions
Spaces method and path for this operation: post /s/{spaceid}/api/workflows/workflow/{workflowId}/executions/cancel Refer to Spaces for more information. Request cancellation for all non-terminal executions of the given workflow in the current space.
Slo
- Read
Get a paginated list of SLOs
You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Read
Retrieve the status of the bulk deletion
Retrieve the status of the bulk deletion operation for SLOs. This endpoint returns the status of the bulk deletion operation, including whether it is completed and the results of the operation.
- Read
Get an SLO
You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Read
Compute an SLO instance summary at a point in time
Compute the summary of an SLO at a given point in time. When instanceId is provided, returns that instance. When instanceId is omitted or set to '', returns all matching instances (up to 1000). The endpoint is synchronous and returns results directly.
- Read
Get the SLO definitions
You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Create an SLO
You must have all privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Bulk delete SLO definitions and their associated summary and rollup data.
Bulk delete SLO definitions and their associated summary and rollup data. This endpoint initiates a bulk deletion operation for SLOs, which may take some time to complete. The status of the operation can be checked using the GET /api/slo/bulkdelete/{taskId} endpoint.
- Write
Batch delete rollup and summary data
The deletion occurs for the specified list of sloId. You must have all privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Compute SLO instance summaries in bulk at a point in time
Compute the summary of multiple SLO instances at a given point in time. The endpoint is synchronous and returns results directly. Each result contains either a summary (on success) or a per-instance error. The list of requests is limited to 100 entries.
- Write
Batch delete rollup and summary data
The deletion occurs for the specified list of sloId and instanceId. You must have all privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Reset an SLO
You must have the write privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Disable an SLO
You must have the write privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Write
Enable an SLO
You must have the write privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Destructive
Update an SLO
You must have the write privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
- Destructive
Delete an SLO
You must have the write privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
No operations match.
See How connections work for access and permissions, or browse all integrations.