config endpoints

Edit online

Use the references for REST API 23.0 config endpoints.

GET /config/access/authorized_services DEPRECATED
Retrieves a list of authorized services. For security reasons, the token field will never be populated in this endpoint. To view any authorized service, the caller must have the Administrator Manager permission. Callers without the Administrator Manager permission can only see the list of authorized services that they've created. An authorized service can see itself and other authorized services that it created, but the Administrator Manager permission is needed to see the complete list of authorized services.
POST /config/access/authorized_services DEPRECATED
Creates an authorized service. The response to this API invocation will contain the API token. This will be the only time the token value is available. Any user or authorized service can call this endpoint. To create an authorized service with any user role, security profile, or tenant, the caller must have the Administrator Manager permission. Callers who don't have the Administrator Manager permission can only create an authorized service with their own user role, security profile and tenant. An authorized service that is created by a caller who doesn't have the Administrator Manager permission expires no later than the default expiration time, even if the caller enters a later time. The default expiration time is also what is set as the expiration date for the authorized service if the expiration_date is not set in the request. This default expiration time can be configured using the Authentication Settings API found here: /api/system/authorization/settings. Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be set when creating an authorized service. All other fields are ignored.
DELETE /config/access/authorized_services/{id} DEPRECATED
Deletes an authorized service. Any user or authorized service can call this endpoint. If the caller has the Administrator Manager permission, then they can delete any authorized service. If the caller does not have the Administrator Manager permission, then they can only delete authorized services that they've created.
GET /config/access/authorized_services/{id} DEPRECATED
Retrieves an authorized service. For security reasons, the token field will never be populated in this endpoint. To view any authorized service, the caller must have the Administrator Manager permission. Callers without the Administrator Manager permission can only see the authorized services that they've created. An authorized service can see itself and other authorized services it created, but the Administrator Manager permission is needed to see the complete list of authorized services.
POST /config/access/authorized_services/{id} DEPRECATED
Updates an authorized service. Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be updated. To view any authorized service, the caller must have the Administrator Manager permission. Callers without the Administrator Manager permission can only see the authorized services that they've created. An authorized service can see itself and other authorized services it created, but the Administrator Manager permission is needed to see the complete list of authorized services. Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be set when creating an authorized service. All other fields are ignored.
GET /config/access/security_profiles DEPRECATED
Get the list of deployed security profiles available in the system.
GET /config/access/security_profiles/{id} DEPRECATED
Get a deployed security profile by ID.
GET /config/access/tenant_management/tenants DEPRECATED
Retrieve the list of all tenants ordered by tenant id.
POST /config/access/tenant_management/tenants DEPRECATED
Create a new tenant.
DELETE /config/access/tenant_management/tenants/{tenant_id} DEPRECATED
Delete a tenant.
GET /config/access/tenant_management/tenants/{tenant_id} DEPRECATED
Retrieve a tenant by tenant id.
POST /config/access/tenant_management/tenants/{tenant_id} DEPRECATED
Update a tenant
GET /config/access/user_dependent_tasks/{task_id} DEPRECATED
Retrieves the dependent user task status.
POST /config/access/user_dependent_tasks/{task_id} DEPRECATED
Cancels a dependent user task.
GET /config/access/user_dependent_tasks/{task_id}/results DEPRECATED
Retrieves the user dependent task results.
GET /config/access/user_roles DEPRECATED
Get the list of deployed user roles available in the system.
GET /config/access/user_roles/{id} DEPRECATED
Get a deployed user role by ID.
GET /config/access/users DEPRECATED
Retrieve Deployed Users.
GET /config/access/users/{id} DEPRECATED
Retrieves a deployed user.
POST /config/access/users/{id} DEPRECATED
Update a deployed user.
GET /config/access/users/{id}/dependents DEPRECATED
Retrieves the objects that depend on the user.
GET /config/backup_and_restore/scheduled_backup_configurations DEPRECATED
Retrieves a list of Backup Configurations.
GET /config/backup_and_restore/scheduled_backup_configurations/{id} DEPRECATED
Retrieves a Backup Configuration by ID.
GET /config/certificates/components DEPRECATED
Gets the list of registered components.
GET /config/certificates/end_certificates DEPRECATED
Gets the list of deployed certificates.
GET /config/certificates/end_certificates/{id} DEPRECATED
Gets information about a specific deployed certificate, as specified the certificate ID.
GET /config/certificates/end_certificates/{id}/full_chain DEPRECATED
Gets the full chain of the certificate. The chain hierarchy includes the content of the end certificate, and the content of the issuer chain certificates, up to and including the root certificate. This endpoint might not return the root certificate if it was uploaded in the last 24 hours
GET /config/certificates/root_certificates DEPRECATED
Gets the list of all root certificates that have been uploaded and deployed. You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /config/certificates/root_certificates/{id} DEPRECATED
Gets details of a deployed root certificate, as specified by the ID. You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /config/certificates/root_certificates/{id}/get_dependant_ids DEPRECATED
Gets a list of end certificate IDs that depend on the root certificate. This endpoint might not return the dependent IDs of the certificates that were uploaded in the last 24 hours.You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /config/deployment/hosts DEPRECATED
Retrieves a list of all deployed hosts.
GET /config/deployment/hosts/{id} DEPRECATED
Retrieves a deployed host by ID.
POST /config/deployment/hosts/{id} DEPRECATED
Updates a host by ID and sends a JMS message to update the pipeline.
GET /config/deployment/hosts/{id}/tunnels DEPRECATED
Gets the list of tunnels for the host.
GET /config/deployment/license_pool DEPRECATED
Retrieves the deployed license pool information.
GET /config/domain_management/domains DEPRECATED
Gets the list of domains.
POST /config/domain_management/domains DEPRECATED
Creates a new domain.
DELETE /config/domain_management/domains/{domain_id} DEPRECATED
Deletes a domain by domain id.
GET /config/domain_management/domains/{domain_id} DEPRECATED
Gets an individual domain by ID
POST /config/domain_management/domains/{domain_id} DEPRECATED
Updates an existing domain.
GET /config/event_retention_buckets DEPRECATED
Retrieves a list of event retention buckets.
DELETE /config/event_retention_buckets/{id} DEPRECATED
Deletes an event retention bucket.
GET /config/event_retention_buckets/{id} DEPRECATED
Retrieves an event retention bucket.
POST /config/event_retention_buckets/{id} DEPRECATED
Updates the event retention bucket owner or enabled/disabled only.
GET /config/event_sources/custom_properties/calculated_properties DEPRECATED
Retrieves a list of calculated event properties.
POST /config/event_sources/custom_properties/calculated_properties DEPRECATED
Creates a new calculated event property.
DELETE /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Deletes the event calculated property. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Retrieves a calculated event property based on the supplied calculated property identifier.
POST /config/event_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Updates an existing calculated event property.
GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents DEPRECATED
Retrieves the objects that depend on the event calculated property.
GET /config/event_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable DEPRECATED
Retrieves the objects that depend on the event calculated property.
GET /config/event_sources/custom_properties/calculated_properties/dep/{calculated_property_id} DEPRECATED
Retrieves a calculated event property based on the supplied calculated property ID.
GET /config/event_sources/custom_properties/calculated_property/{calculated_property_name} DEPRECATED
Retrieves a list of event calculated properties.
GET /config/event_sources/custom_properties/calculated_property_delete_tasks/{task_id} DEPRECATED
Retrieves the status of the event calculated property delete task.
GET /config/event_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id} DEPRECATED
Retrieves the event calculated property dependent task status.
POST /config/event_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id} DEPRECATED
Cancels the calculated property dependent task.
GET /config/event_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id}/results DEPRECATED
Retrieves the calculated property dependent task results.
GET /config/event_sources/custom_properties/calculated_property_dependent_tasks/{task_id} DEPRECATED
Retrieves the status of the event calculated property dependents task.
POST /config/event_sources/custom_properties/calculated_property_dependent_tasks/{task_id} DEPRECATED
Cancels the event calculated property dependent task.
GET /config/event_sources/custom_properties/calculated_property_dependent_tasks/{task_id}/results DEPRECATED
Retrieves the calculated property dependent task results.
GET /config/event_sources/custom_properties/calculated_property_operands DEPRECATED
Retrieves the list of available options for calculated event property operand.
GET /config/event_sources/custom_properties/property_aql_expressions DEPRECATED
Gets the list of Custom Property AQL Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
POST /config/event_sources/custom_properties/property_aql_expressions DEPRECATED
Creates a new Custom Property AQL expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
DELETE /config/event_sources/custom_properties/property_aql_expressions/{expression_id} DEPRECATED
Deletes a Custom Property AQL expression based on the supplied expression ID. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
GET /config/event_sources/custom_properties/property_aql_expressions/{expression_id} DEPRECATED
Gets a Custom Property AQL Expression by ID. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
POST /config/event_sources/custom_properties/property_aql_expressions/{expression_id} DEPRECATED
Updates a Custom Property AQL expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
GET /config/event_sources/custom_properties/property_calculated_expressions DEPRECATED
Gets the list of Custom Property Calculated Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
POST /config/event_sources/custom_properties/property_calculated_expressions DEPRECATED
Creates a new Custom Property Calculated Expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
DELETE /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} DEPRECATED
Deletes a Custom Property Calculated Expression based on the supplied expression ID. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
GET /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} DEPRECATED
Gets a Custom Property Calculated Expression by ID. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
POST /config/event_sources/custom_properties/property_calculated_expressions/{expression_id} DEPRECATED
Updates a Custom Property Calculated Expression. Requires the System Administrator, Security Admin or User Defined Event Properties permission.
GET /config/event_sources/custom_properties/property_cef_expressions DEPRECATED
Retrieves a list of CEF expressions.
POST /config/event_sources/custom_properties/property_cef_expressions DEPRECATED
Creates a new CEF expression.
DELETE /config/event_sources/custom_properties/property_cef_expressions/{expression_id} DEPRECATED
Deletes a CEF expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_cef_expressions/{expression_id} DEPRECATED
Retrieves a CEF expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_cef_expressions/{expression_id} DEPRECATED
Updates an existing CEF expression.
GET /config/event_sources/custom_properties/property_expressions DEPRECATED
Retrieves a list of event regex property expressions.
POST /config/event_sources/custom_properties/property_expressions DEPRECATED
Creates a new event regex property expression.
DELETE /config/event_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Deletes an event regex property expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Retrieves a event regex property expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Updates an existing event regex property expression.
GET /config/event_sources/custom_properties/property_genericlist_expressions DEPRECATED
Retrieves a list of Generic List expressions.
POST /config/event_sources/custom_properties/property_genericlist_expressions DEPRECATED
Creates a new Generic List expression.
DELETE /config/event_sources/custom_properties/property_genericlist_expressions/{expression_id} DEPRECATED
Deletes a Generic List expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_genericlist_expressions/{expression_id} DEPRECATED
Retrieves a Generic List expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_genericlist_expressions/{expression_id} DEPRECATED
Updates an existing Generic List expression.
GET /config/event_sources/custom_properties/property_json_expressions DEPRECATED
Retrieves a list of JSON expressions.
POST /config/event_sources/custom_properties/property_json_expressions DEPRECATED
Creates a new JSON expression.
DELETE /config/event_sources/custom_properties/property_json_expressions/{expression_id} DEPRECATED
Deletes a JSON expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_json_expressions/{expression_id} DEPRECATED
Retrieves a JSON expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_json_expressions/{expression_id} DEPRECATED
Updates an existing JSON expression.
GET /config/event_sources/custom_properties/property_leef_expressions DEPRECATED
Retrieves the list of LEEF Expressions.
POST /config/event_sources/custom_properties/property_leef_expressions DEPRECATED
Creates a new LEEF Expression.
DELETE /config/event_sources/custom_properties/property_leef_expressions/{expression_id} DEPRECATED
Deletes a LEEF Expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_leef_expressions/{expression_id} DEPRECATED
Retrieves a LEEF Expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_leef_expressions/{expression_id} DEPRECATED
Updates an existing LEEF Expression.
GET /config/event_sources/custom_properties/property_nvp_expressions DEPRECATED
Retrieves a list of Name Value Pair expressions.
POST /config/event_sources/custom_properties/property_nvp_expressions DEPRECATED
Creates a new Name Value Pair expression.
DELETE /config/event_sources/custom_properties/property_nvp_expressions/{expression_id} DEPRECATED
Deletes a Name Value Pair expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_nvp_expressions/{expression_id} DEPRECATED
Retrieves a Name Value Pair expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_nvp_expressions/{expression_id} DEPRECATED
Updates an existing Name Value Pair expression.
GET /config/event_sources/custom_properties/property_xml_expressions DEPRECATED
Retrieves a list of XML expressions.
POST /config/event_sources/custom_properties/property_xml_expressions DEPRECATED
Creates a new XML expression.
DELETE /config/event_sources/custom_properties/property_xml_expressions/{expression_id} DEPRECATED
Deletes an XML expression based on the supplied identifier.
GET /config/event_sources/custom_properties/property_xml_expressions/{expression_id} DEPRECATED
Retrieves a XML expression based on the supplied identifier.
POST /config/event_sources/custom_properties/property_xml_expressions/{expression_id} DEPRECATED
Updates an existing XML expression.
GET /config/event_sources/custom_properties/regex_properties DEPRECATED
Retrieves a list of event regex properties.
POST /config/event_sources/custom_properties/regex_properties DEPRECATED
Creates a new event regex property.
DELETE /config/event_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Deletes an event regex property. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task is started to do this check.
GET /config/event_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Retrieves a event regex property based on the supplied regex property ID.
POST /config/event_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Updates an existing event regex property.
GET /config/event_sources/custom_properties/regex_properties/{regex_property_id}/dependents DEPRECATED
Retrieves the objects that depend on the event regex property.
GET /config/event_sources/custom_properties/regex_properties/{regex_property_id}/dependents/change_field_type DEPRECATED
Retrieves the objects that depend on the event regex property for changing type of field for it.
GET /config/event_sources/custom_properties/regex_properties/{regex_property_id}/dependents/disable DEPRECATED
Retrieves the objects that depend on the event regex property for disabling it.
GET /config/event_sources/custom_properties/regex_property_delete_tasks/{task_id} DEPRECATED
Retrieves the event regex property delete task status.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id} DEPRECATED
Retrieves the event regex property dependent task status.
POST /config/event_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id} DEPRECATED
Cancels the regex property dependent task.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id} DEPRECATED
Retrieves the event regex property dependent task status.
POST /config/event_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id} DEPRECATED
Cancels the regex property dependent task.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id} DEPRECATED
Retrieves the event regex property dependent task status.
POST /config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id} DEPRECATED
Cancels the regex property dependent task.
GET /config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/event_sources/disconnected_log_collectors DEPRECATED
Retrieves a list of disconnected log collectors.
POST /config/event_sources/disconnected_log_collectors DEPRECATED
Creates a new disconnected log collector. A disconnected log collector contains the following fields:
DELETE /config/event_sources/disconnected_log_collectors/{id} DEPRECATED
Deletes a Disconnected Log Collector by ID.
GET /config/event_sources/disconnected_log_collectors/{id} DEPRECATED
Retrieves an disconnected log collector by ID..
POST /config/event_sources/disconnected_log_collectors/{id} DEPRECATED
Updates a disconnected log collector by ID. A disconnected log collector contains the following fields:
GET /config/event_sources/event_collectors DEPRECATED
Retrieves a list of event collectors..
GET /config/event_sources/event_collectors/{id} DEPRECATED
Retrieves an event collector by ID..
POST /config/event_sources/generated_regexes DEPRECATED
Retrieves a regex pattern
GET /config/event_sources/log_source_management/autodetection/config_records DEPRECATED
Retrieves the list of Autodetection Config Records.
POST /config/event_sources/log_source_management/autodetection/config_records DEPRECATED
Creates an Autodetection Config Record.
GET /config/event_sources/log_source_management/autodetection/config_records/{config_id} DEPRECATED
Gets an individual Autodetection Config Record by id.
POST /config/event_sources/log_source_management/autodetection/config_records/{config_id} DEPRECATED
Updates an Autodetection Config Record.
GET /config/event_sources/log_source_management/log_source_bulk_tasks/{id} DEPRECATED
Retrieves a log source bulk task by ID.
POST /config/event_sources/log_source_management/log_source_bulk_tasks/{id} DEPRECATED
Updates a log source bulk task. The only field that can be updated is the 'status' field, and the only allowed value is 'CANCELLED'.
GET /config/event_sources/log_source_management/log_source_extensions DEPRECATED
Retrieves the list of log source extensions.
GET /config/event_sources/log_source_management/log_source_extensions/{id} DEPRECATED
Retrieves a log source extension by ID.
GET /config/event_sources/log_source_management/log_source_groups DEPRECATED
Retrieves the list of log source groups.
POST /config/event_sources/log_source_management/log_source_groups DEPRECATED
Creates a new log source group. A log source group contains the following fields:
GET /config/event_sources/log_source_management/log_source_groups/{id} DEPRECATED
Retrieves a log source group by ID.
GET /config/event_sources/log_source_management/log_source_languages DEPRECATED
Retrieves the list of log source languages.
GET /config/event_sources/log_source_management/log_source_languages/{id} DEPRECATED
Retrieves a log source language by ID.
POST /config/event_sources/log_source_management/log_source_statistics DEPRECATED
Creates log source statistics Log source statistics contains the following fields: LogSourceFieldValueStatistic contains the following fields:
GET /config/event_sources/log_source_management/log_source_types DEPRECATED
Retrieves a list of log source types. If called by a user/authorized service with System Administrator, Security Admin, or Manage Log Source Types permissions, then all fields will be returned in each log source type. If called by a less privileged client, only name and ID are returned in each log source type.
POST /config/event_sources/log_source_management/log_source_types DEPRECATED
Create a new custom log source type. Log source types do not need to be deployed. The following fields can be provided in the body of this request, all other log source type fields will be ignored:
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_allowed_values DEPRECATED
Retrieve dsm parameter allowed values.
PATCH /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_allowed_values DEPRECATED
Create new dsm parameter allowed values or Update available dsm parameter allowed values. The following fields can be provided in the body of this request, all other dsm parameter allowed value fields will be ignored: >
DELETE /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_allowed_values/{id} DEPRECATED
Deletes a dsm paramater allowed value by ID.
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_allowed_values/{id} DEPRECATED
Retrieve a dsm parameter allowed value by id.
POST /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_allowed_values/{id} DEPRECATED
Update a dsm parameter allowed value by id.
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameter_definition DEPRECATED
Retrieve dsm parameter definitions.
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters DEPRECATED
Retrieve dsm parameters.
PATCH /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters DEPRECATED
Create new dsm parameters or Update available dsm parameters. The following fields can be provided in the body of this request, all other dsm parameter fields will be ignored:
DELETE /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters/{id} DEPRECATED
Deletes a dsm paramater by ID.
GET /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters/{id} DEPRECATED
Retrieve a dsm parameter by id.
POST /config/event_sources/log_source_management/log_source_types/dsm_parameter_configuration/dsm_parameters/{id} DEPRECATED
Update a dsm parameter by id.
DELETE /config/event_sources/log_source_management/log_source_types/{id} DEPRECATED
Deletes a custom log source type by ID.
GET /config/event_sources/log_source_management/log_source_types/{id} DEPRECATED
Retrieves a log source type by ID. If called by a user/authorized service with System Administrator, Security Admin, or Manage Log Source Types permissions, then all fields will be returned for the log source type. If called by a less privileged client, only name and ID are returned for the log source type.
POST /config/event_sources/log_source_management/log_source_types/{id} DEPRECATED
Updates a log source type by ID. The following fields can be provided in the body of this request, all other log source type fields will be ignored:
GET /config/event_sources/log_source_management/log_sources DEPRECATED
Retrieves a list of log sources.
PATCH /config/event_sources/log_source_management/log_sources DEPRECATED
Patches an array of log sources. Capable of creating, updating and deleting multiple log sources in the same transaction.
POST /config/event_sources/log_source_management/log_sources DEPRECATED
Creates a new log source. A log source contains the following fields:
DELETE /config/event_sources/log_source_management/log_sources/{id} DEPRECATED
Deletes a log source by ID.
GET /config/event_sources/log_source_management/log_sources/{id} DEPRECATED
Retrieves a log source by ID.
POST /config/event_sources/log_source_management/log_sources/{id} DEPRECATED
Updates a log source by ID.
GET /config/event_sources/log_source_management/protocol_types DEPRECATED
Retrieves the list of protocol types. Requires the System Administrator, Security Admin, or Manage Log Sources permission.
GET /config/event_sources/log_source_management/protocol_types/{id} DEPRECATED
Retrieves a protocol type by ID. Requires the System Administrator, Security Admin, or Manage Log Sources permission.
GET /config/event_sources/property_discovery_profiles DEPRECATED
Gets all PropertyDiscoveryProfiles currently in the system.
POST /config/event_sources/property_discovery_profiles DEPRECATED
Creates a PropertyDiscoveryProfile based on the information supplied by the property_discovery_profile JSON object.
DELETE /config/event_sources/property_discovery_profiles/{id} DEPRECATED
Deletes the specified PropertyDiscoveryProfile.
GET /config/event_sources/property_discovery_profiles/{id} DEPRECATED
Gets a PropertyDiscoveryProfile based on the information supplied by the property_discovery_profile corresponding to the supplied ID.
POST /config/event_sources/property_discovery_profiles/{id} DEPRECATED
Updates a PropertyDiscoveryProfile based on the information supplied via the property_discovery_profile JSON object.
GET /config/event_sources/wincollect/wincollect_agents DEPRECATED
Retrieves a list of WinCollect agents.
GET /config/event_sources/wincollect/wincollect_agents/{id} DEPRECATED
Retrieves a WinCollect agent by ID.
GET /config/event_sources/wincollect/wincollect_destinations DEPRECATED
Retrieves a list of WinCollect destinations.
GET /config/event_sources/wincollect/wincollect_destinations/{id} DEPRECATED
Retrieves a WinCollect destination by ID.
POST /config/extension_management/extension_export_tasks DEPRECATED
Exports an extension.
GET /config/extension_management/extension_export_tasks/{task_id} DEPRECATED
Retrieves the tasks status based on the task_id.
GET /config/extension_management/extension_export_tasks/{task_id}/extension_export DEPRECATED
Retrieves the exported extension based on the task_id.
GET /config/extension_management/extension_export_tasks/{task_id}/results DEPRECATED
Retrieves the tasks status results based on the task_id.
GET /config/extension_management/extensions DEPRECATED
Retrieve a list of extensions.
POST /config/extension_management/extensions DEPRECATED
Uploads the supplied extension file to the QRadar system.
DELETE /config/extension_management/extensions/{extension_id} DEPRECATED
Uninstall an extension based on the supplied extension_id. This is an asynchronous action.
GET /config/extension_management/extensions/{extension_id} DEPRECATED
Retrieves an extension based on the supplied extension_id.
POST /config/extension_management/extensions/{extension_id} DEPRECATED
Install an extension based on the supplied extension_id. This is an asynchronous action.
POST /config/extension_management/extensions/{extension_id}/metadata DEPRECATED
Adds metadata to the Extension corresponding to the supplied extension_id.
GET /config/extension_management/extensions_task_status/{status_id} DEPRECATED
Retrieves the tasks status based on the status_id.
GET /config/extension_management/extensions_task_status/{status_id}/results DEPRECATED
Retrieves the tasks status results based on the status_id.
GET /config/flow/applications/active_applications DEPRECATED
Gets the list of active flow applications.
GET /config/flow/applications/active_applications/{id} DEPRECATED
Gets an individual active flow application that is currently deployed in the system, as specified by the application ID. Active applications are flow applications that are currently in-use by the system. Changes or modifications to a flow application should always be made to the active applications list. Do not update the default applications. You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /config/flow/applications/default_applications DEPRECATED
Gets the list of default flow applications.
GET /config/flow/applications/default_applications/{id} DEPRECATED
Gets an individual default flow application, as specified by an ID.
GET /config/flow/common_destination_ports/active_configurations DEPRECATED
Gets the list of active configurations for common destination ports.
POST /config/flow/common_destination_ports/active_configurations DEPRECATED
Creates a new active configuration.
DELETE /config/flow/common_destination_ports/active_configurations/{id} DEPRECATED
Removes the active configuration for the specified ID from the system.
GET /config/flow/common_destination_ports/active_configurations/{id} DEPRECATED
Gets the active configuration for a common destination port, as specified by an ID.
POST /config/flow/common_destination_ports/active_configurations/{id} DEPRECATED
Updates the active configuration for a common destination port, as specified by the ID.
GET /config/flow/common_destination_ports/default_configurations DEPRECATED
Gets the list of default configurations for common destination ports.
GET /config/flow/common_destination_ports/default_configurations/{id} DEPRECATED
Gets the default configuration for a common destination port, as specified by an ID.
GET /config/flow_retention_buckets DEPRECATED
Retrieves a list of flow retention buckets.
DELETE /config/flow_retention_buckets/{id} DEPRECATED
Deletes a flow retention bucket.
GET /config/flow_retention_buckets/{id} DEPRECATED
Retrieves a flow retention bucket.
POST /config/flow_retention_buckets/{id} DEPRECATED
Updates the flow retention bucket owner, or enabled/disabled only.
GET /config/flow_sources/custom_properties/calculated_properties DEPRECATED
Retrieves a list of calculated flow properties.
POST /config/flow_sources/custom_properties/calculated_properties DEPRECATED
Creates a new calculated flow property.
DELETE /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Deletes the flow calculated property. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Retrieves a calculated flow property based on the supplied calculated property ID.
POST /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id} DEPRECATED
Updates an existing calculated flow property.
GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents DEPRECATED
Retrieves the objects that depend on the flow calculated property.
GET /config/flow_sources/custom_properties/calculated_properties/{calculated_property_id}/dependents/disable DEPRECATED
Retrieves the objects that depend on the flow calculated property.
GET /config/flow_sources/custom_properties/calculated_properties/dep/{calculated_property_id} DEPRECATED
Retrieves a calculated flow property based on the supplied calculated property ID.
GET /config/flow_sources/custom_properties/calculated_property/{calculated_property_name} DEPRECATED
Retrieves a list of flow calculated properties.
GET /config/flow_sources/custom_properties/calculated_property_delete_tasks/{task_id} DEPRECATED
Retrieves the status of the flow calculated property delete task.
GET /config/flow_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id} DEPRECATED
Retrieves the flow calculated property dependent task status.
POST /config/flow_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id} DEPRECATED
Cancels the calculated property dependent task.
GET /config/flow_sources/custom_properties/calculated_property_dependent_tasks/disable/{task_id}/results DEPRECATED
Retrieves the calculated property dependent task results.
GET /config/flow_sources/custom_properties/calculated_property_dependent_tasks/{task_id} DEPRECATED
Retrieves the status of the flow calculated property dependents task.
POST /config/flow_sources/custom_properties/calculated_property_dependent_tasks/{task_id} DEPRECATED
Cancels the flow calculated property dependent task.
GET /config/flow_sources/custom_properties/calculated_property_dependent_tasks/{task_id}/results DEPRECATED
Retrieves the calculated property dependent task results.
GET /config/flow_sources/custom_properties/calculated_property_operands DEPRECATED
Retrieves the list of available options for calculated flow property operand.
GET /config/flow_sources/custom_properties/property_expressions DEPRECATED
Retrieve a list of flow regex property expressions.
POST /config/flow_sources/custom_properties/property_expressions DEPRECATED
Creates a new flow regex property expression.
DELETE /config/flow_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Deletes a flow regex property expression based on the supplied expression ID.
GET /config/flow_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Retrieves a flow regex property expression based on the supplied expression ID.
POST /config/flow_sources/custom_properties/property_expressions/{expression_id} DEPRECATED
Updates an existing flow regex property expression.
GET /config/flow_sources/custom_properties/regex_properties DEPRECATED
Retrieves a list of flow regex properties.
POST /config/flow_sources/custom_properties/regex_properties DEPRECATED
Creates a new flow regex property.
DELETE /config/flow_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Deletes a flow regex property. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task is started to do this check.
GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Retrieves a flow regex property based on the supplied regex property ID.
POST /config/flow_sources/custom_properties/regex_properties/{regex_property_id} DEPRECATED
Updates an existing flow regex property.
GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id}/dependents DEPRECATED
Retrieves the objects that depend on the flow regex property.
GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id}/dependents/change_field_type DEPRECATED
Retrieves the objects that depend on the flow regex property for changing type of field for it.
GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id}/disabling_dependents DEPRECATED
Retrieves the objects that depend on the flow regex property.
GET /config/flow_sources/custom_properties/regex_property_delete_tasks/{task_id} DEPRECATED
Retrieves the flow regex property delete task status.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id} DEPRECATED
Retrieves the flow regex property dependent task status.
POST /config/flow_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id} DEPRECATED
Cancels the regex property dependent task.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/change_field_type/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id} DEPRECATED
Retrieves the flow regex property dependent task status.
POST /config/flow_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id} DEPRECATED
Cancels the regex property dependent task.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/disable/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id} DEPRECATED
Retrieves the flow regex property dependent task status.
POST /config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id} DEPRECATED
Cancels the flow regex property dependent task.
GET /config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id}/results DEPRECATED
Retrieves the regex property dependent task results.
GET /config/flow_sources/flow_source_management/flowSources DEPRECATED
Gets the list of flow sources that are available to the current user.
GET /config/flow_sources/flow_source_management/flowSources/{id} DEPRECATED
Gets an individual Flow Source as specified by the ID.
GET /config/network_hierarchy/networks DEPRECATED
Retrieves the deployed network hierarchy.
GET /config/network_hierarchy/staged_networks DEPRECATED
Retrieves the staged network hierarchy.
PUT /config/network_hierarchy/staged_networks DEPRECATED
Replaces the current network hierarchy with the input that is provided.
GET /config/remote_networks DEPRECATED
Retrieves a list of deployed remote networks.
GET /config/remote_networks/{network_id} DEPRECATED
Retrieves a deployed remote network by ID.
GET /config/remote_services DEPRECATED
Retrieves a list of deployed remote services.
GET /config/remote_services/{service_id} DEPRECATED
Retrieves a deployed remote service by ID.
POST /config/resilient/test DEPRECATED
Perform asynchronous test Resilient connection
POST /config/resilient/test/{id} DEPRECATED
Test the Resilient connection by using the connection ID. You must have the System Administrator or Security Admin permission (ADMIN | SAASADMIN capability) to use this endpoint.
GET /config/resilient/test/{task_id} DEPRECATED
Get the test Resilient connection task status You must have the System Administrator or Security Admin permission (ADMIN | SAASADMIN capability) to use this endpoint.
GET /config/resource_restrictions DEPRECATED
Retrieves a list of all resource restrictions.
POST /config/resource_restrictions DEPRECATED
Creates a new resource restriction.
DELETE /config/resource_restrictions/{resource_restriction_id} DEPRECATED
Deletes a resource restriction consumer by ID.
GET /config/resource_restrictions/{resource_restriction_id} DEPRECATED
Retrieves a resource restriction consumer by ID.
PUT /config/resource_restrictions/{resource_restriction_id} DEPRECATED
Updates a resource restriction consumer by ID.
GET /config/store_and_forward/policies DEPRECATED
Retrieves a list of store and forward policies.
DELETE /config/store_and_forward/policies/{id} DEPRECATED
Deletes a store and forward policy.
GET /config/store_and_forward/policies/{id} DEPRECATED
Retrieves a store and forward policy.
POST /config/store_and_forward/policies/{id} DEPRECATED
Updates the store and forward policy owner only.