This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get index pattern API
editGet index pattern API
editDeprecated in 8.0.0.
Use the data views API instead.
[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Retrieve a single Kibana index pattern by ID.
Request
editGET <kibana host>:<port>/api/index_patterns/index_pattern/<id>
GET <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<id>
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used. -
id
- (Required, string) The ID of the index pattern you want to retrieve.
Response code
edit-
200
- Indicates a successful call.
-
404
- The specified index pattern and ID doesn’t exist.
Example
editRetrieve the index pattern object with the my-pattern
ID:
$ curl -X GET api/index_patterns/index_pattern/my-pattern
The API returns an index pattern object:
{ "index_pattern": { "id": "my-pattern", "version": "...", "title": "...", "type": "...", "timeFieldName": "...", "sourceFilters": [], "fields": {}, "typeMeta": {}, "fieldFormats": {}, "fieldAttrs": {}, "runtimeFieldMap" {}, "allowNoIndex: "..." } }