X-Pack APIs¶
X-Pack is an Elastic Stack extension that bundles security, alerting, monitoring, reporting, and graph capabilities into one easy-to-install package. While the X-Pack components are designed to work together seamlessly, you can easily enable or disable the features you want to use.
Info¶
X-Pack info provides general info about the installed X-Pack.
- class elasticsearch.client.xpack.XPackClient(*args, **kwargs)¶
- info(params=None)¶
Retrieve information about xpack, including build number/timestamp and license status https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html
- Parameters
categories – Comma-separated list of info categories. Can be any of: build, license, features
human – Presents additional info for humans (feature descriptions and X-Pack tagline)
- usage(params=None)¶
Retrieve information about xpack features usage
- Parameters
master_timeout – Specify timeout for watch write operation
Graph Explore¶
X-Pack Graph Explore enables you to extract and summarize information about the documents and terms in your Elasticsearch index.
- class elasticsearch.client.xpack.graph.GraphClient(client)¶
- explore(index=None, doc_type=None, body=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
- Parameters
index – A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
doc_type – A comma-separated list of document types to search; leave empty to perform the operation on all types
body – Graph Query DSL
routing – Specific routing value
timeout – Explicit operation timeout
Licensing API¶
Licensing API can be used to manage your licences.
- class elasticsearch.client.xpack.license.LicenseClient(client)¶
- delete(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- get(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- Parameters
local – Return local information, do not retrieve the state from master node (default: false)
- get_basic_status(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- get_trial_status(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- post(body=None, params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- Parameters
body – licenses to be installed
acknowledge – whether the user has acknowledged acknowledge messages (default: false)
- post_start_basic(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- Parameters
acknowledge – whether the user has acknowledged acknowledge messages (default: false)
- post_start_trial(params=None)¶
https://www.elastic.co/guide/en/x-pack/current/license-management.html
- Parameters
acknowledge – whether the user has acknowledged acknowledge messages (default: false)
doc_type – The type of trial license to generate (default: “trial”)
Machine Learning APIs¶
Machine Learning can be useful for discovering new patterns about your data. For a more detailed explanation about X-Pack’s machine learning please refer to the official documentation.
- class elasticsearch.client.xpack.ml.MlClient(client)¶
- close_job(job_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
- Parameters
job_id – The name of the job to close
body – The URL params optionally sent in the body
allow_no_jobs – Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)
force – True if the job should be forcefully closed
timeout – Controls the time to wait until a job has closed. Default to 30 minutes
- delete_calendar(calendar_id, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to delete
- delete_calendar_event(calendar_id, event_id, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to modify
event_id – The ID of the event to remove from the calendar
- delete_calendar_job(calendar_id, job_id, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to modify
job_id – The ID of the job to remove from the calendar
- delete_datafeed(datafeed_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to delete
force – True if the datafeed should be forcefully deleted
- delete_forecast(job_id, forecast_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html
- Parameters
job_id – The ID of the job from which to delete forecasts
forecast_id – The ID of the forecast to delete, can be comma delimited list. Leaving blank implies _all
allow_no_forecasts – Whether to ignore if _all matches no forecasts
timeout – Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
- delete_job(job_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
- Parameters
job_id – The ID of the job to delete
force – True if the job should be forcefully deleted, default False
wait_for_completion – Should this request wait until the operation has completed before returning, default True
- delete_model_snapshot(job_id, snapshot_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
- Parameters
job_id – The ID of the job to fetch
snapshot_id – The ID of the snapshot to delete
- find_file_structure(body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure.html
- Parameters
body – The contents of the file to be analyzed
charset – Optional parameter to specify the character set of the file
column_names – Optional parameter containing a comma separated list of the column names for a delimited file
delimiter – Optional parameter to specify the delimiter character for a delimited file - must be a single character
explain – Whether to include a commentary on how the structure was derived, default False
format – Optional parameter to specify the high level file format, valid choices are: ‘ndjson’, ‘xml’, ‘delimited’, ‘semi_structured_text’
grok_pattern – Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
has_header_row – Optional parameter to specify whether a delimited file includes the column names in its first row
lines_to_sample – How many lines of the file should be included in the analysis, default 1000
quote – Optional parameter to specify the quote character for a delimited file - must be a single character
should_trim_fields – Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
timeout – Timeout after which the analysis will be aborted, default ’25s’
timestamp_field – Optional parameter to specify the timestamp field in the file
timestamp_format – Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
- flush_job(job_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
- Parameters
job_id – The name of the job to flush
body – Flush parameters
advance_time – Advances time to the given value generating results and updating the model for the advanced interval
calc_interim – Calculates interim results for the most recent bucket or all buckets within the latency period
end – When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
skip_time – Skips time to the given value without generating results or updating the model for the skipped interval
start – When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
- forecast(job_id, params=None)¶
-
- Parameters
job_id – The ID of the job to forecast for
duration – The duration of the forecast
expires_in – The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
- get_buckets(job_id, timestamp=None, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
- Parameters
job_id – ID of the job to get bucket results from
timestamp – The timestamp of the desired single bucket result
body – Bucket selection details if not provided in URI
anomaly_score – Filter for the most anomalous buckets
desc – Set the sort direction
end – End time filter for buckets
exclude_interim – Exclude interim results
expand – Include anomaly records
from – skips a number of buckets
size – specifies a max number of buckets to get
sort – Sort buckets by a particular field
start – Start time filter for buckets
- get_calendar_events(calendar_id, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar containing the events
end – Get events before this time
from – Skips a number of events
job_id – Get events for the job. When this option is used calendar_id must be ‘_all’
size – Specifies a max number of events to get
start – Get events after this time
- get_calendars(calendar_id=None, body=None, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to fetch
body – The from and size parameters optionally sent in the body
from – skips a number of calendars
size – specifies a max number of calendars to get
- get_categories(job_id, category_id=None, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
- Parameters
job_id – The name of the job
category_id – The identifier of the category definition of interest
body – Category selection details if not provided in URI
from – skips a number of categories
size – specifies a max number of categories to get
- get_datafeed_stats(datafeed_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
- Parameters
datafeed_id – The ID of the datafeeds stats to fetch
allow_no_datafeeds – Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)
- get_datafeeds(datafeed_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
- Parameters
datafeed_id – The ID of the datafeeds to fetch
allow_no_datafeeds – Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)
- get_filters(filter_id=None, params=None)¶
-
- Parameters
filter_id – The ID of the filter to fetch
from – skips a number of filters
size – specifies a max number of filters to get
- get_influencers(job_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
- Parameters
job_id – None
body – Influencer selection criteria
desc – whether the results should be sorted in decending order
end – end timestamp for the requested influencers
exclude_interim – Exclude interim results
from – skips a number of influencers
influencer_score – influencer score threshold for the requested influencers
size – specifies a max number of influencers to get
sort – sort field for the requested influencers
start – start timestamp for the requested influencers
- get_job_stats(job_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
- Parameters
job_id – The ID of the jobs stats to fetch
allow_no_jobs – Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)
- get_jobs(job_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
- Parameters
job_id – The ID of the jobs to fetch
allow_no_jobs – Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)
- get_model_snapshots(job_id, snapshot_id=None, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
- Parameters
job_id – The ID of the job to fetch
snapshot_id – The ID of the snapshot to fetch
body – Model snapshot selection criteria
desc – True if the results should be sorted in descending order
end – The filter ‘end’ query parameter
from – Skips a number of documents
size – The default number of documents returned in queries as a string.
sort – Name of the field to sort on
start – The filter ‘start’ query parameter
- get_overall_buckets(job_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
- Parameters
job_id – The job IDs for which to calculate overall bucket results
body – Overall bucket selection details if not provided in URI
allow_no_jobs – Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)
bucket_span – The span of the overall buckets. Defaults to the longest job bucket_span
end – Returns overall buckets with timestamps earlier than this time
exclude_interim – If true overall buckets that include interim buckets will be excluded
overall_score – Returns overall buckets with overall scores higher than this value
start – Returns overall buckets with timestamps after this time
top_n – The number of top job bucket scores to be used in the overall_score calculation
- get_records(job_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
- Parameters
job_id – None
body – Record selection criteria
desc – Set the sort direction
end – End time filter for records
exclude_interim – Exclude interim results
from – skips a number of records
record_score –
size – specifies a max number of records to get
sort – Sort records by a particular field
start – Start time filter for records
- open_job(job_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
- Parameters
job_id – The ID of the job to open
- post_calendar_events(calendar_id, body, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to modify
body – A list of events
- post_data(job_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html
- Parameters
job_id – The name of the job receiving the data
body – The data to process
reset_end – Optional parameter to specify the end of the bucket resetting range
reset_start – Optional parameter to specify the start of the bucket resetting range
- preview_datafeed(datafeed_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to preview
- put_calendar(calendar_id, body=None, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to create
body – The calendar details
- put_calendar_job(calendar_id, job_id, params=None)¶
-
- Parameters
calendar_id – The ID of the calendar to modify
job_id – The ID of the job to add to the calendar
- put_datafeed(datafeed_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to create
body – The datafeed config
- put_filter(filter_id, body, params=None)¶
-
- Parameters
filter_id – The ID of the filter to create
body – The filter details
- put_job(job_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html
- Parameters
job_id – The ID of the job to create
body – The job
- revert_model_snapshot(job_id, snapshot_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
- Parameters
job_id – The ID of the job to fetch
snapshot_id – The ID of the snapshot to revert to
body – Reversion options
delete_intervening_results – Should we reset the results back to the time of the snapshot?
- set_upgrade_mode(params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
- Parameters
enabled – Whether to enable upgrade_mode ML setting or not. Defaults to false.
timeout – Controls the time to wait before action times out. Defaults to 30 seconds
- start_datafeed(datafeed_id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to start
body – The start datafeed parameters
end – The end time when the datafeed should stop. When not set, the datafeed continues in real time
start – The start time from where the datafeed should begin
timeout – Controls the time to wait until a datafeed has started. Default to 20 seconds
- stop_datafeed(datafeed_id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to stop
allow_no_datafeeds – Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)
force – True if the datafeed should be forcefully stopped.
timeout – Controls the time to wait until a datafeed has stopped. Default to 20 seconds
- update_datafeed(datafeed_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
- Parameters
datafeed_id – The ID of the datafeed to update
body – The datafeed update settings
- update_filter(filter_id, body, params=None)¶
-
- Parameters
filter_id – The ID of the filter to update
body – The filter update
- update_job(job_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
- Parameters
job_id – The ID of the job to create
body – The job update settings
- update_model_snapshot(job_id, snapshot_id, body, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
- Parameters
job_id – The ID of the job to fetch
snapshot_id – The ID of the snapshot to update
body – The model snapshot properties to update
Security APIs¶
Security API can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.
- class elasticsearch.client.xpack.security.SecurityClient(client)¶
- authenticate(params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
- change_password(body, username=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
- Parameters
body – the new password for the user
username – The username of the user to change the password for
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- clear_cached_realms(realms, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
- Parameters
realms – Comma-separated list of realms to clear
usernames – Comma-separated list of usernames to clear from the cache
- clear_cached_roles(name, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
- Parameters
name – Role name
- create_api_key(body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
- Parameters
body – The api key request to create an API key
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- delete_privileges(application, name, params=None)¶
-
- Parameters
application – Application name
name – Privilege name
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- delete_role(name, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
- Parameters
name – Role name
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- delete_role_mapping(name, params=None)¶
-
- Parameters
name – Role-mapping name
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- delete_user(username, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
- Parameters
username – username
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- disable_user(username, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
- Parameters
username – The username of the user to disable
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- enable_user(username, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
- Parameters
username – The username of the user to enable
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- get_api_key(params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
- Parameters
id – API key id of the API key to be retrieved
name – API key name of the API key to be retrieved
realm_name – realm name of the user who created this API key to be retrieved
username – user name of the user who created this API key to be retrieved
- get_privileges(application=None, name=None, params=None)¶
-
- Parameters
application – Application name
name – Privilege name
- get_role(name=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
- Parameters
name – Role name
- get_role_mapping(name=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html
- Parameters
name – Role-Mapping name
- get_token(body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html
- Parameters
body – The token request to get
- get_user(username=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html
- Parameters
username – A comma-separated list of usernames
- get_user_privileges(params=None)¶
- has_privileges(body, user=None, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
- Parameters
body – The privileges to test
user – Username
- invalidate_api_key(body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
- Parameters
body – The api key request to invalidate API key(s)
- invalidate_token(body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html
- Parameters
body – The token to invalidate
- put_privileges(body, params=None)¶
-
- Parameters
body – The privilege(s) to add
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- put_role(name, body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
- Parameters
name – Role name
body – The role to add
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- put_role_mapping(name, body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html
- Parameters
name – Role-mapping name
body – The role to add
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
- put_user(username, body, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html
- Parameters
username – The username of the User
body – The user to add
refresh – If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes., valid choices are: ‘true’, ‘false’, ‘wait_for’
Watcher APIs¶
Watcher API can be used to notify you when certain pre-defined thresholds have happened.
- class elasticsearch.client.xpack.watcher.WatcherClient(client)¶
- ack_watch(watch_id, action_id=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
- Parameters
watch_id – Watch ID
action_id – A comma-separated list of the action ids to be acked
- activate_watch(watch_id, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html
- Parameters
watch_id – Watch ID
- deactivate_watch(watch_id, params=None)¶
https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html
- Parameters
watch_id – Watch ID
- delete_watch(id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
- Parameters
id – Watch ID
- execute_watch(id=None, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html
- Parameters
id – Watch ID
body – Execution control
debug – indicates whether the watch should execute in debug mode
- get_watch(id, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html
- Parameters
id – Watch ID
- put_watch(id, body=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html
- Parameters
id – Watch ID
body – The watch
active – Specify whether the watch is in/active by default
if_primary_term – only update the watch if the last operation that has changed the watch has the specified primary term
if_seq_no – only update the watch if the last operation that has changed the watch has the specified sequence number
version – Explicit version number for concurrency control
- start(params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html
- stats(metric=None, params=None)¶
http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html
- Parameters
metric – Controls what additional stat metrics should be include in the response
emit_stacktraces – Emits stack traces of currently running watches
Migration APIs¶
Migration API helps simplify upgrading X-Pack indices from one version to another.
- class elasticsearch.client.xpack.migration.MigrationClient(client)¶
- deprecations(index=None, params=None)¶
http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html
- Parameters
index – Index pattern