ariel endpoints

Edit online

Use the references for REST API 29.0 ariel endpoints.

GET /ariel/databases
Retrieves a list of available Ariel database names
GET /ariel/databases/{database_name}
Retrieve the columns that are defined for a specific Ariel database.
GET /ariel/event_saved_search_groups
Retrieves a list the event Ariel saved search groups.
DELETE /ariel/event_saved_search_groups/{group_id}
Deletes an event Ariel saved search group.
GET /ariel/event_saved_search_groups/{group_id}
Retrieves an event Ariel saved search group.
POST /ariel/event_saved_search_groups/{group_id}
Updates the owner of an event Ariel saved search group.
GET /ariel/flow_saved_search_groups
Retrieves a list of flow Ariel saved search groups.
DELETE /ariel/flow_saved_search_groups/{group_id}
Deletes a flow Ariel saved search group.
GET /ariel/flow_saved_search_groups/{group_id}
Retrieves a flow Ariel saved search group.
POST /ariel/flow_saved_search_groups/{group_id}
Updates the owner of a flow Ariel saved search group.
GET /ariel/flow_vlans
Retrieves a list of available flow VLAN IDs in the Ariel database.
POST /ariel/flow_vlans
Creates a new flow VLAN field as specified by input parameters.
DELETE /ariel/flow_vlans/{id}
Deletes a flow VLAN ID with specified enterprise and customer VLAN ID's and removes any associated domain mappings.
GET /ariel/flow_vlans/{id}
Retrieves a flow VLAN ID object by VLAN ID.
GET /ariel/functions
Retrieves AQL Functions for given .
GET /ariel/functions/{function_name}
Retrieves AQL Function with given name for a given database.
GET /ariel/lookups
Retrieves a list of all tagged field lookups.
POST /ariel/lookups
Creates a new tagged field lookup.
DELETE /ariel/lookups/{name}
Deletes a tagged field lookup with particular name.
GET /ariel/lookups/{name}
Retrieves a tagged field lookup by name.
POST /ariel/lookups/{name}
Updates a tagged field lookup with particular name.
GET /ariel/parser_keywords
Retrieves keywords applicable to AQL Parser.
POST /ariel/processors/aql_metadata
Parses the AQL query expression and returns metadata for this query
GET /ariel/saved_search_delete_tasks/{task_id}
Retrieves the delete the Ariel saved search task status.
GET /ariel/saved_search_dependent_tasks/{task_id}
Retrieves the dependent the Ariel saved search task status.
POST /ariel/saved_search_dependent_tasks/{task_id}
Cancels the dependent Ariel saved search task.
GET /ariel/saved_search_dependent_tasks/{task_id}/results
Retrieves the Ariel saved search dependent task results.
GET /ariel/saved_searches
Retrieves a list of Ariel saved searches.
DELETE /ariel/saved_searches/{id}
Deletes an Ariel saved search. To ensure safe deletion, a dependency check is carried out. The check might take some time. An asynchronous task is started to do this check.
GET /ariel/saved_searches/{id}
Retrieves an Ariel saved search.
POST /ariel/saved_searches/{id}
Updates the Ariel saved search.
GET /ariel/saved_searches/{id}/dependents
Retrieves the objects that depend on the Ariel saved search.
GET /ariel/searches
Retrieves the list of Ariel searches. Search IDs for completed and active searches are returned.
POST /ariel/searches
Create a new asynchronous Ariel search.
DELETE /ariel/searches/{search_id}
Deletes an Ariel search.
GET /ariel/searches/{search_id}
Retrieves information about an Ariel search.
POST /ariel/searches/{search_id}
Updates an Ariel search.
GET /ariel/searches/{search_id}/metadata
Retrieve the columns that are defined for a specific Ariel search id.
GET /ariel/searches/{search_id}/results
Retrieves search results in the requested format.
GET /ariel/taggedfieldcategories
Gets the list of categories for tagged fields.
POST /ariel/taggedfieldcategories
Creates a new category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
DELETE /ariel/taggedfieldcategories/{id}
Removes the category for tagged fields from the system. To use this endpoint, you must have System Administrator or Security Admin permissions.
GET /ariel/taggedfieldcategories/{id}
Gets a category for tagged fields.
POST /ariel/taggedfieldcategories/{id}
Updates a category for tagged fields. To use this endpoint, you must have System Administrator or Security Admin permissions.
GET /ariel/taggedfields
Gets the list of tagged fields.
POST /ariel/taggedfields
Creates a new tagged field. To use this endpoint, you must have System Administrator or Security Admin permissions.
DELETE /ariel/taggedfields/{id}
Removes a tagged field from the system. To use this endpoint, you must have System Administrator or Security Admin permissions.
GET /ariel/taggedfields/{id}
Gets an individual tagged field.
POST /ariel/taggedfields/{id}
Updates a tagged field specified by an id. You must have the ADMIN | SAASADMIN capability to use this endpoint.
POST /ariel/validators/aql
Validates the AQL query expression.