Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Dashboards – Deletes all the dashboards in the Squirro project
  • Elasticsearch Index – Deletes all the documents in the Elasticsearch index.
  • Facets – Deletes all the facets. Please note that in order to do a reset of facets, a reset of elasticsearch is mandatory (in the same API call using the relevant boolean flags).

POST httpsPOST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/reset

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
JSON Data
  • reset_dashboards – Boolean flag to decide whether to reset the project dashboards or not. If True, will delete all the dashboards in the current project. Defaults to False false if not specified.
  • reset_elasticsearch_index – Boolean flag to decide whether to reset/delete all documents in a project’s elasticsearch index or not without deleting the index itself. Defaults to Falsefalse if not specified.
  • reset_facets – Boolean flag to decide whether to delete all the facets in the project. This needs the reset_elasticsearch_index flag to be set to Truetrue. Be aware that all the dashboards and other Squirro entities dependent on the current facets will stop working with the reset of facets. Defaults to Falsefalse if not specified.
Headers:See Common Headers.
Status Codes:
  • 200 – Squirro Project entities were reset.

See also Common Status Codes.