RESTful API

Modified: 2016-10-18

Copyright © 2016, Juniper Networks, Inc.

Release

2014.8

Juniper Networks, Inc.1133 InnovationWaySunnyvale, California 94089USA408-745-2000www.juniper.net

Copyright © 2016, Juniper Networks, Inc. All rights reserved.

Juniper Networks, Junos, Steel-Belted Radius, NetScreen, and ScreenOS are registered trademarks of Juniper Networks, Inc. in the UnitedStates and other countries. The Juniper Networks Logo, the Junos logo, and JunosE are trademarks of Juniper Networks, Inc. All othertrademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners.

Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify,transfer, or otherwise revise this publication without notice.

RESTful APICopyright © 2016, Juniper Networks, Inc.All rights reserved.

The information in this document is current as of the date on the title page.

YEAR 2000 NOTICE

Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related limitations through theyear 2038. However, the NTP application is known to have some difficulty in the year 2036.

ENDUSER LICENSE AGREEMENT

The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with) Juniper Networkssoftware. Use of such software is subject to the terms and conditions of the End User License Agreement (“EULA”) posted athttp://www.juniper.net/support/eula.html. By downloading, installing or using such software, you agree to the terms and conditions ofthat EULA.

Copyright © 2016, Juniper Networks, Inc.ii

http://www.juniper.net/support/eula.html

Table of Contents

About the Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxv

Documentation and Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxv

Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxv

Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxvii

Requesting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxviii

Self-Help Online Tools and Resources . . . . . . . . . . . . . . . . . . . . . . . . . cxviii

Opening a Case with JTAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cxviii

Chapter 1 What's New for Developers in RESTful APIs in JSA 2014.8 . . . . . . . . . . . . . . 121

What's New for Developers in RESTful APIs in JSA 2014.8 . . . . . . . . . . . . . . . . . . 121

New Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Deprecated Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

New Endpoints in More Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Building Block Rules API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Custom Rules API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Ariel Saved Searches API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Asset Saved Searches API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Event Regex Property API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Event Regex Property Expression API Endpoints . . . . . . . . . . . . . . . . . . . . . . 128

Flow Regex Property API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Flow Regex Property Expression API Endpoints . . . . . . . . . . . . . . . . . . . . . . . 129

Global System Notifications API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Network Hierarchy API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Resource Restrictions API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Retention Buckets API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Store and Forward Policy API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

DSM Event Mappings API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

High Level Categories API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Low Level Categories API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

QID Records API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

JSA Risk Manager Groups API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Vulnerability Saved Searches API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . 134

Reference Data API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Offense Saved Searches API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Deploy Status API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Yara Rules API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Locales API Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Deprecated Endpoints in More Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

iiiCopyright © 2016, Juniper Networks, Inc.

Chapter 2 RESTful API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

RESTful API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

API Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Required Permissions to Access the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

API Requests and Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Version Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Endpoint Deprecation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Filter Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Comparison Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Null Values and Comparison Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Logical Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Specifying JSON Fields for Comparisons . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Specifying String and Numeric Values in Filters . . . . . . . . . . . . . . . . . . . . . . . 147

Filtering Complex Objects by Using the CONTAINS Operator . . . . . . . . . . . . 147

The LIKE Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Sort Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Sort Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Sorting Multiple Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Escaping Characters in Sort Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Paging Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Range Header Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

API Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Cross-origin Resource Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Management Of Allowed Origins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Chapter 3 API Command-line Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

API Command-line Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Basic API Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Calls with Path Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Calls with Query Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Calls with Body Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Calls to Other Consoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Stored Tokens Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

User Name and Password Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

API Client Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Chapter 4 Accessing the Interactive API Documentation Page . . . . . . . . . . . . . . . . . . . 159

Accessing the Interactive API Documentation Page . . . . . . . . . . . . . . . . . . . . . . . 159

Chapter 5 REST API V7.0 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

REST API V7.0 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Analytics Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

GET /analytics/ade_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

GET /analytics/ade_rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Copyright © 2016, Juniper Networks, Inc.iv

RESTful API

POST /analytics/ade_rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

DELETE /analytics/ade_rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

GET /analytics/ade_rules/{id}/dependents . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

GET /analytics/ade_rules/ade_rule_delete_tasks/{task_id} . . . . . . . . . . . . . . 171

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

GET /analytics/ade_rules/ade_rule_dependent_tasks/{task_id} . . . . . . . . . . 172

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

POST /analytics/ade_rules/ade_rule_dependent_tasks/{task_id} . . . . . . . . 175

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

GET /analytics/ade_rules/ade_rule_dependent_tasks/{task_id}/results . . . 178

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

GET /analytics/building_blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

GET /analytics/building_blocks/building_block_delete_tasks/{task_id} . . . 182

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

GET

/analytics/building_blocks/building_block_dependent_tasks/{task_id} . . 184

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

POST

/analytics/building_blocks/building_block_dependent_tasks/{task_id} . . 186

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

GET

/analytics/building_blocks/building_block_dependent_tasks/{task_id}/results. . 190

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

GET /analytics/building_blocks/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

POST /analytics/building_blocks/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

DELETE /analytics/building_blocks/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

vCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /analytics/building_blocks/{id}/dependents . . . . . . . . . . . . . . . . . . . . . 196

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

GET /analytics/custom_actions/actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

POST /analytics/custom_actions/actions . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

GET /analytics/custom_actions/actions/{action_id} . . . . . . . . . . . . . . . . . . 203

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

POST /analytics/custom_actions/actions/{action_id} . . . . . . . . . . . . . . . . . 204

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

DELETE /analytics/custom_actions/actions/{action_id} . . . . . . . . . . . . . . . 207

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

GET /analytics/custom_actions/interpreters . . . . . . . . . . . . . . . . . . . . . . . . 207

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

GET /analytics/custom_actions/interpreters/{interpreter_id} . . . . . . . . . . . 208

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

GET /analytics/custom_actions/scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

POST /analytics/custom_actions/scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

GET /analytics/custom_actions/scripts/{script_id} . . . . . . . . . . . . . . . . . . . . 212

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

POST /analytics/custom_actions/scripts/{script_id} . . . . . . . . . . . . . . . . . . 213

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

DELETE /analytics/custom_actions/scripts/{script_id} . . . . . . . . . . . . . . . . 214

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

GET /analytics/rule_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

GET /analytics/rule_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

POST /analytics/rule_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

DELETE /analytics/rule_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Copyright © 2016, Juniper Networks, Inc.vi

RESTful API

GET /analytics/rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

GET /analytics/rules/rule_delete_tasks/{task_id} . . . . . . . . . . . . . . . . . . . . . 223

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

GET /analytics/rules/rule_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . . 224

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

POST /analytics/rules/rule_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . 227

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

GET /analytics/rules/rule_dependent_tasks/{task_id}/results . . . . . . . . . . 230

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

GET /analytics/rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

POST /analytics/rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

DELETE /analytics/rules/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

GET /analytics/rules/{id}/dependents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Ariel Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

GET /ariel/databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

GET /ariel/databases/{database_name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

GET /ariel/event_saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

GET /ariel/event_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . 244

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

POST /ariel/event_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . 246

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

DELETE /ariel/event_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . 248

GET /ariel/flow_saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

viiCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /ariel/flow_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . . 250

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

POST /ariel/flow_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . 252

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

DELETE /ariel/flow_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . 254

GET /ariel/saved_search_delete_tasks/{task_id} . . . . . . . . . . . . . . . . . . . . . 255

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

GET /ariel/saved_search_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . . 256

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

POST /ariel/saved_search_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . 259

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

GET /ariel/saved_search_dependent_tasks/{task_id}/results . . . . . . . . . . . 262

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

GET /ariel/saved_searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

GET /ariel/saved_searches/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

POST /ariel/saved_searches/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

DELETE /ariel/saved_searches/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

GET /ariel/saved_searches/{id}/dependents . . . . . . . . . . . . . . . . . . . . . . . . 270

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

GET /ariel/searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

POST /ariel/searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

GET /ariel/searches/{search_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

POST /ariel/searches/{search_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

DELETE /ariel/searches/{search_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Copyright © 2016, Juniper Networks, Inc.viii

RESTful API

GET /ariel/searches/{search_id}/results . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Asset Model Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

GET /asset_model/assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

POST /asset_model/assets/{asset_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

GET /asset_model/properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

GET /asset_model/saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

GET /asset_model/saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . 289

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

POST /asset_model/saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . 291

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

DELETE /asset_model/saved_search_groups/{group_id} . . . . . . . . . . . . . . 293

GET /asset_model/saved_searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

GET /asset_model/saved_searches/{saved_search_id} . . . . . . . . . . . . . . . . 295

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

POST /asset_model/saved_searches/{saved_search_id} . . . . . . . . . . . . . . 297

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

DELETE /asset_model/saved_searches/{saved_search_id} . . . . . . . . . . . . 299

GET /asset_model/saved_searches/{saved_search_id}/results . . . . . . . . . 300

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

Authentication Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

POST /auth/logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Configuration Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

GET /config/access/tenant_management/tenants . . . . . . . . . . . . . . . . . . . 305

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

POST /config/access/tenant_management/tenants . . . . . . . . . . . . . . . . . 306

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

ixCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /config/access/tenant_management/tenants/{tenant_id} . . . . . . . . . 307

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

POST /config/access/tenant_management/tenants/{tenant_id} . . . . . . . 308

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

DELETE /config/access/tenant_management/tenants/{tenant_id} . . . . . 309

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

GET /config/domain_management/domains . . . . . . . . . . . . . . . . . . . . . . . . 310

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

POST /config/domain_management/domains . . . . . . . . . . . . . . . . . . . . . . . 312

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

GET /config/domain_management/domains/{domain_id} . . . . . . . . . . . . . 313

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

POST /config/domain_management/domains/{domain_id} . . . . . . . . . . . . 315

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

DELETE /config/domain_management/domains/{domain_id} . . . . . . . . . . 317

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

GET /config/event_retention_buckets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

GET /config/event_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . 320

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

POST /config/event_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . . . 322

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

DELETE /config/event_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . 323

GET /config/event_sources/custom_properties/property_expressions . . . . 324

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

POST /config/event_sources/custom_properties/property_expressions . . . 326

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

GET

/config/event_sources/custom_properties/property_expressions/{expression_id}. . 328

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

POST

/config/event_sources/custom_properties/property_expressions/{expression_id}. . 330

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

Copyright © 2016, Juniper Networks, Inc.x

RESTful API

DELETE

/config/event_sources/custom_properties/property_expressions/{expression_id}. . 334

GET /config/event_sources/custom_properties/regex_properties . . . . . . . . 334

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

POST /config/event_sources/custom_properties/regex_properties . . . . . . . 336

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

GET

/config/event_sources/custom_properties/regex_properties/{regex_property_id}. . 338

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

POST

/config/event_sources/custom_properties/regex_properties/{regex_property_id}. . 339

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

DELETE

/config/event_sources/custom_properties/regex_properties/{regex_property_id}. . 342

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

GET

/config/event_sources/custom_properties/regex_properties/{regex_property_id}/dependents. . 344

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

GET

/config/event_sources/custom_properties/regex_property_delete_tasks/{task_id}. . 347

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

GET

/config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id}. . 349

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

POST

/config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id}. . 352

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

GET

/config/event_sources/custom_properties/regex_property_dependent_tasks/{task_id}/results. . 355

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

GET /config/extension_management/extensions . . . . . . . . . . . . . . . . . . . . . 357

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

POST /config/extension_management/extensions . . . . . . . . . . . . . . . . . . . . 361

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GET /config/extension_management/extensions/{extension_id} . . . . . . . . 363

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

xiCopyright © 2016, Juniper Networks, Inc.

Table of Contents

POST /config/extension_management/extensions/{extension_id} . . . . . . 366

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

DELETE /config/extension_management/extensions/{extension_id} . . . . . 368

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

GET

/config/extension_management/extensions_task_status/{status_id} . . 369

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

GET

/config/extension_management/extensions_task_status/{status_id}/results. . 371

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

GET /config/flow_retention_buckets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

GET /config/flow_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

POST /config/flow_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

DELETE /config/flow_retention_buckets/{id} . . . . . . . . . . . . . . . . . . . . . . . . 378

GET /config/flow_sources/custom_properties/property_expressions . . . . . 378

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

POST /config/flow_sources/custom_properties/property_expressions . . . 380

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

GET

/config/flow_sources/custom_properties/property_expressions/{expression_id}. . 383

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

POST

/config/flow_sources/custom_properties/property_expressions/{expression_id}. . 384

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

DELETE

/config/flow_sources/custom_properties/property_expressions/{expression_id}. . 388

GET /config/flow_sources/custom_properties/regex_properties . . . . . . . . . 388

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

POST /config/flow_sources/custom_properties/regex_properties . . . . . . . 390

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Copyright © 2016, Juniper Networks, Inc.xii

RESTful API

GET

/config/flow_sources/custom_properties/regex_properties/{regex_property_id}. . 392

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

POST

/config/flow_sources/custom_properties/regex_properties/{regex_property_id}. . 393

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

DELETE

/config/flow_sources/custom_properties/regex_properties/{regex_property_id}. . 396

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

GET

/config/flow_sources/custom_properties/regex_properties/{regex_property_id}/dependents. . 398

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

GET

/config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id}. . 401

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

POST

/config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id}. . 404

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

GET

/config/flow_sources/custom_properties/regex_property_dependent_tasks/{task_id}/results. . 408

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

GET /config/global_system_notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

GET /config/global_system_notifications/{notification_id} . . . . . . . . . . . . . . 411

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

GET /config/network_hierarchy/networks . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

GET /config/network_hierarchy/staged_networks . . . . . . . . . . . . . . . . . . . . . 413

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

PUT /config/network_hierarchy/staged_networks . . . . . . . . . . . . . . . . . . . . . 414

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

GET /config/resource_restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

POST /config/resource_restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

xiiiCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /config/resource_restrictions/{resource_restriction_id} . . . . . . . . . . . . 418

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

DELETE /config/resource_restrictions/{resource_restriction_id} . . . . . . . . . 420

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

PUT /config/resource_restrictions/{resource_restriction_id} . . . . . . . . . . . . 420

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

GET /config/store_and_forward/policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

GET /config/store_and_forward/policies/{id} . . . . . . . . . . . . . . . . . . . . . . . . 423

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

POST /config/store_and_forward/policies/{id} . . . . . . . . . . . . . . . . . . . . . . 424

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

DELETE /config/store_and_forward/policies/{id} . . . . . . . . . . . . . . . . . . . . 426

Data Classification Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

GET /data_classification/dsm_event_mappings . . . . . . . . . . . . . . . . . . . . . . 427

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

POST /data_classification/dsm_event_mappings . . . . . . . . . . . . . . . . . . . . 429

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

GET

/data_classification/dsm_event_mappings/{dsm_event_mapping_id} . . 430

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

POST

/data_classification/dsm_event_mappings/{dsm_event_mapping_id} . . 432

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

GET /data_classification/high_level_categories . . . . . . . . . . . . . . . . . . . . . . 434

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

GET

/data_classification/high_level_categories/{high_level_category_id} . . 435

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

GET /data_classification/low_level_categories . . . . . . . . . . . . . . . . . . . . . . . 436

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

GET /data_classification/low_level_categories/{low_level_category_id} . . 438

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

GET /data_classification/qid_records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

Copyright © 2016, Juniper Networks, Inc.xiv

RESTful API

POST /data_classification/qid_records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

GET /data_classification/qid_records/{qid_record_id} . . . . . . . . . . . . . . . . . 442

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

POST /data_classification/qid_records/{qid_record_id} . . . . . . . . . . . . . . . . 444

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

GUI Application Framework Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

GET /gui_app_framework/application_creation_task . . . . . . . . . . . . . . . . . . 446

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

POST /gui_app_framework/application_creation_task . . . . . . . . . . . . . . . . . 447

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

GET /gui_app_framework/application_creation_task/{application_id} . . . . 448

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

POST /gui_app_framework/application_creation_task/{application_id} . . 449

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

GET /gui_app_framework/applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

GET /gui_app_framework/applications/{application_id} . . . . . . . . . . . . . . . 453

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

POST /gui_app_framework/applications/{application_id} . . . . . . . . . . . . . 456

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

PUT /gui_app_framework/applications/{application_id} . . . . . . . . . . . . . . 459

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

DELETE /gui_app_framework/applications/{application_id} . . . . . . . . . . . . 461

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Help Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

GET /help/endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

GET /help/endpoints/{endpoint_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

GET /help/resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

GET /help/resources/{resource_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

xvCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /help/versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

GET /help/versions/{version_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

JSA Risk Manager Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

GET /qrm/model_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

GET /qrm/model_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

POST /qrm/model_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

DELETE /qrm/model_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

GET /qrm/qrm_saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

GET /qrm/qrm_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . . 483

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

POST /qrm/qrm_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . 484

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

DELETE /qrm/qrm_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . 486

GET /qrm/question_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

GET /qrm/question_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

POST /qrm/question_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

DELETE /qrm/question_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . 493

GET /qrm/simulation_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

GET /qrm/simulation_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

POST /qrm/simulation_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . . 497

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498

DELETE /qrm/simulation_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . 499

Copyright © 2016, Juniper Networks, Inc.xvi

RESTful API

GET /qrm/topology_saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . 499

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

GET /qrm/topology_saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . 501

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

POST /qrm/topology_saved_search_groups/{group_id} . . . . . . . . . . . . . . . 503

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

DELETE /qrm/topology_saved_search_groups/{group_id} . . . . . . . . . . . . . 505

JSA Vulnerability Manager Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

GET /qvm/assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

GET /qvm/filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

GET /qvm/network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

GET /qvm/openservices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

GET /qvm/saved_search_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

GET /qvm/saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . . . 511

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

POST /qvm/saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . . 513

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

DELETE /qvm/saved_search_groups/{group_id} . . . . . . . . . . . . . . . . . . . . . . 515

GET /qvm/saved_searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

GET /qvm/saved_searches/vuln_instances/{task_id}/results/assets . . . . . . 517

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

GET

/qvm/saved_searches/vuln_instances/{task_id}/results/vuln_instances . . 519

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

GET

/qvm/saved_searches/vuln_instances/{task_id}/results/vulnerabilities . . 520

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

GET /qvm/saved_searches/vuln_instances/{task_id}/status . . . . . . . . . . . 522

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

POST /qvm/saved_searches/vuln_instances/{task_id}/status . . . . . . . . . . 523

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

xviiCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /qvm/saved_searches/{saved_search_id} . . . . . . . . . . . . . . . . . . . . . . . 525

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

POST /qvm/saved_searches/{saved_search_id} . . . . . . . . . . . . . . . . . . . . . 526

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

DELETE /qvm/saved_searches/{saved_search_id} . . . . . . . . . . . . . . . . . . . 528

GET /qvm/saved_searches/{saved_search_id}/vuln_instances . . . . . . . . . . 528

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

POST /qvm/tickets/assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

GET /qvm/vulns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

Reference Data Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

GET /reference_data/map_delete_tasks/{task_id} . . . . . . . . . . . . . . . . . . . . 533

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

GET /reference_data/map_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . 534

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

POST /reference_data/map_dependent_tasks/{task_id} . . . . . . . . . . . . . . . 537

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

GET /reference_data/map_dependent_tasks/{task_id}/results . . . . . . . . . 540

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542

GET /reference_data/map_of_sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

POST /reference_data/map_of_sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545

POST /reference_data/map_of_sets/bulk_load/{name} . . . . . . . . . . . . . . . 545

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

GET /reference_data/map_of_sets/{name} . . . . . . . . . . . . . . . . . . . . . . . . . 547

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548

POST /reference_data/map_of_sets/{name} . . . . . . . . . . . . . . . . . . . . . . . . 548

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

DELETE /reference_data/map_of_sets/{name} . . . . . . . . . . . . . . . . . . . . . . 549

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

GET /reference_data/map_of_sets/{name}/dependents . . . . . . . . . . . . . . . 551

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552

Copyright © 2016, Juniper Networks, Inc.xviii

RESTful API

DELETE /reference_data/map_of_sets/{name}/{key} . . . . . . . . . . . . . . . . . 553

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554

GET /reference_data/map_of_sets_delete_tasks/{task_id} . . . . . . . . . . . . . 554

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556

GET /reference_data/map_of_sets_dependent_tasks/{task_id} . . . . . . . . . 556

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558

POST /reference_data/map_of_sets_dependent_tasks/{task_id} . . . . . . . . 559

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561

GET /reference_data/map_of_sets_dependent_tasks/{task_id}/results . . . 562

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

GET /reference_data/maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

POST /reference_data/maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567

POST /reference_data/maps/bulk_load/{name} . . . . . . . . . . . . . . . . . . . . . 567

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568

GET /reference_data/maps/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

POST /reference_data/maps/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

DELETE /reference_data/maps/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

GET /reference_data/maps/{name}/dependents . . . . . . . . . . . . . . . . . . . . 573

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

DELETE /reference_data/maps/{name}/{key} . . . . . . . . . . . . . . . . . . . . . . . 575

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576

GET /reference_data/set_delete_tasks/{task_id} . . . . . . . . . . . . . . . . . . . . . 576

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577

GET /reference_data/set_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . . 578

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579

POST /reference_data/set_dependent_tasks/{task_id} . . . . . . . . . . . . . . . . 581

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583

xixCopyright © 2016, Juniper Networks, Inc.

Table of Contents

GET /reference_data/set_dependent_tasks/{task_id}/results . . . . . . . . . . . 584

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585

GET /reference_data/sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587

POST /reference_data/sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588

POST /reference_data/sets/bulk_load/{name} . . . . . . . . . . . . . . . . . . . . . . 589

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

GET /reference_data/sets/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

POST /reference_data/sets/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592

DELETE /reference_data/sets/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594

DELETE /reference_data/sets/{name}/{value} . . . . . . . . . . . . . . . . . . . . . . 595

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596

GET /reference_data/sets/{name}/dependents . . . . . . . . . . . . . . . . . . . . . 596

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597

GET /reference_data/tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

POST /reference_data/tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601

POST /reference_data/tables/bulk_load/{name} . . . . . . . . . . . . . . . . . . . . 601

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

Response Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

GET /reference_data/tables/{name} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

Response Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603

Response Sample . . . . . . . .