- Elastic Cloud Serverless
- Elasticsearch
- Elastic Observability
- Get started
- Observability overview
- Elastic Observability Serverless billing dimensions
- Create an Observability project
- Quickstart: Monitor hosts with Elastic Agent
- Quickstart: Monitor your Kubernetes cluster with Elastic Agent
- Quickstart: Monitor hosts with OpenTelemetry
- Quickstart: Unified Kubernetes Observability with Elastic Distributions of OpenTelemetry (EDOT)
- Quickstart: Collect data with AWS Firehose
- Get started with dashboards
- Applications and services
- Application performance monitoring (APM)
- Get started with traces and APM
- Learn about data types
- Collect application data
- View and analyze data
- Act on data
- Use APM securely
- Reduce storage
- Managed intake service event API
- Troubleshooting
- Synthetic monitoring
- Get started
- Scripting browser monitors
- Configure lightweight monitors
- Manage monitors
- Work with params and secrets
- Analyze monitor data
- Monitor resources on private networks
- Use the CLI
- Configure a Synthetics project
- Multifactor Authentication for browser monitors
- Configure Synthetics settings
- Grant users access to secured resources
- Manage data retention
- Scale and architect a deployment
- Synthetics Encryption and Security
- Troubleshooting
- Application performance monitoring (APM)
- Infrastructure and hosts
- Logs
- Inventory
- Incident management
- Data set quality
- Observability AI Assistant
- Machine learning
- Reference
- Get started
- Elastic Security
- Elastic Security overview
- Security billing dimensions
- Create a Security project
- Elastic Security requirements
- Elastic Security UI
- AI for Security
- Ingest data
- Configure endpoint protection with Elastic Defend
- Manage Elastic Defend
- Endpoints
- Policies
- Trusted applications
- Event filters
- Host isolation exceptions
- Blocklist
- Optimize Elastic Defend
- Event capture and Elastic Defend
- Endpoint protection rules
- Identify antivirus software on your hosts
- Allowlist Elastic Endpoint in third-party antivirus apps
- Elastic Endpoint self-protection features
- Elastic Endpoint command reference
- Endpoint response actions
- Cloud Security
- Explore your data
- Dashboards
- Detection engine overview
- Rules
- Alerts
- Advanced Entity Analytics
- Investigation tools
- Asset management
- Manage settings
- Troubleshooting
- Manage your project
- Changelog
Management API conventions
editManagement API conventions
editThe Management REST APIs for Elastic Cloud Serverless let you manage resources that are available in multiple solutions. These resources include connectors, data views, and saved objects. If you’ve previously used the Elastic Stack, the Management APIs are similar to Kibana APIs.
Management API calls are stateless. Each request that you make happens in isolation from other calls and must include all of the necessary information for Kibana to fulfill the request. API requests return JSON output, which is a format that is machine-readable and works well for automation.
To interact with Management APIs, use the following operations:
- GET: Fetches the information.
- POST: Adds new information.
- PUT: Updates the existing information.
- DELETE: Removes the information.
You can prepend any Management API endpoint with kbn: and run the request in Dev Tools → Console.
For example:
GET kbn:/api/data_views
Check out Console.
Request headers
editWhen you call Management APIs outside of the Console, you must provide a request header.
The Management APIs support the Authorization, Content-Type, and kbn-xsrf headers.
-
Authorization: ApiKey - Management APIs use key-based authentication. You must create an API key and use the encoded value in the request header. To learn about creating keys, go to API keys.
-
Content-Type: application/json -
You must use this header when you send a payload in the API request.
Typically, if you include the
kbn-xsrfheader, you must also include theContent-Typeheader. -
kbn-xsrf: true -
You must use this header for all API calls except
GETorHEADoperations.
For example:
curl -X POST \ "${KIBANA_URL}/api/data_views/data_view" \ -H "Authorization: ApiKey ${API_KEY}" \ -H 'Content-Type: application/json' \ -H 'kbn-xsrf: true' \ -d '{ "data_view": { "title": "books*", "name": "My Books Data View" } } '
On this page