ml-ad-apis.asciidoc 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. [role="xpack"]
  2. [[ml-ad-apis]]
  3. = {ml-cap} {anomaly-detect} APIs
  4. You can use the following APIs to perform {ml} {anomaly-detect} activities.
  5. See also <<ml-apis>>, <<ml-df-analytics-apis>>, <<ml-df-trained-models-apis>>.
  6. [discrete]
  7. [[ml-api-anomaly-job-endpoint]]
  8. == {anomaly-jobs-cap}
  9. //* <<ml-valid-detector,Validate detectors>>, <<ml-valid-job,Validate job>>
  10. * <<ml-put-job,Create>> or <<ml-delete-job,delete {anomaly-jobs}>>
  11. * <<ml-put-calendar-job,Add>> or <<ml-delete-calendar-job,delete a {anomaly-job} from a calendar>>
  12. * <<ml-open-job,Open>> or <<ml-close-job,close {anomaly-jobs}>>
  13. * <<ml-get-job,Get {anomaly-jobs} info>> or <<ml-get-job-stats,statistics>>
  14. * <<ml-flush-job,Flush {anomaly-jobs}>>
  15. * <<ml-post-data,Post data to {anomaly-jobs}>>
  16. * <<ml-update-job,Update {anomaly-jobs}>>
  17. * <<ml-forecast,Create>> or <<ml-delete-forecast,delete forecasts>>
  18. * <<ml-reset-job,Reset {anomaly-jobs}>>
  19. [discrete]
  20. [[ml-api-calendar-endpoint]]
  21. == Calendars
  22. * <<ml-put-calendar,Create calendar>>, <<ml-delete-calendar,Delete calendar>>
  23. * <<ml-put-calendar-job,Add job to calendar>>, <<ml-delete-calendar-job,Delete job from calendar>>
  24. * <<ml-post-calendar-event,Add scheduled events to calendar>>, <<ml-delete-calendar-event,Delete scheduled events from calendar>>
  25. * <<ml-get-calendar,Get calendars>>, <<ml-get-calendar-event,Get scheduled events>>
  26. [discrete]
  27. [[ml-api-filter-endpoint]]
  28. == Filters
  29. * <<ml-put-filter,Create filter>>, <<ml-delete-filter,Delete filter>>
  30. * <<ml-update-filter,Update filters>>
  31. * <<ml-get-filter,Get filters>>
  32. [discrete]
  33. [[ml-api-datafeed-endpoint]]
  34. == {dfeeds-cap}
  35. * <<ml-put-datafeed,Create {dfeed}>>, <<ml-delete-datafeed,Delete {dfeed}>>
  36. * <<ml-start-datafeed,Start {dfeed}>>, <<ml-stop-datafeed,Stop {dfeed}>>
  37. * <<ml-get-datafeed,Get {dfeed} info>>, <<ml-get-datafeed-stats,Get {dfeed} statistics>>
  38. * <<ml-preview-datafeed,Preview {dfeed}>>
  39. * <<ml-update-datafeed,Update {dfeed}>>
  40. [discrete]
  41. [[ml-api-snapshot-endpoint]]
  42. == Model snapshots
  43. * <<ml-delete-snapshot,Delete model snapshot>>
  44. * <<ml-get-snapshot,Get model snapshot info>>
  45. * <<ml-get-job-model-snapshot-upgrade-stats,Get model snapshot upgrade statistics>>
  46. * <<ml-revert-snapshot,Revert model snapshot>>
  47. * <<ml-update-snapshot,Update model snapshot>>
  48. * <<ml-upgrade-job-model-snapshot,Upgrade model snapshot>>
  49. [discrete]
  50. [[ml-api-result-endpoint]]
  51. == Results
  52. * <<ml-get-bucket,Get buckets>>
  53. * <<ml-get-overall-buckets,Get overall buckets>>
  54. * <<ml-get-category,Get categories>>
  55. * <<ml-get-influencer,Get influencers>>
  56. * <<ml-get-record,Get records>>
  57. [discrete]
  58. [[ml-api-delete-expired-data-endpoint]]
  59. == Delete expired data
  60. * <<ml-delete-expired-data,Delete expired data>>