FortiNAC - REST API

Version F 7.4.0
FORTINET DOCUMENT LIBRARY
https://docs.fortinet.com

FORTINET VIDEO LIBRARY

https://video.fortinet.com

FORTINET BLOG
https://blog.fortinet.com

CUSTOMER SERVICE & SUPPORT

https://support.fortinet.com

FORTINET TRAINING & CERTIFICATION PROGRAM

https://www.fortinet.com/training-certification

FORTINET TRAINING INSTITUTE

https://training.fortinet.com

FORTIGUARD LABS
https://www.fortiguard.com

END USER LICENSE AGREEMENT

https://www.fortinet.com/doc/legal/EULA.pdf

FEEDBACK
Email: [email protected]

February 26, 2024

FortiNAC F 7.4.0 REST API
00-400-000000-20181031
 TABLE OF CONTENTS

Introduction 161
Welcome to the FortiNAC REST API! 161
Generate an API Token 162
Step 1: Determine your Source Address 162
Step 2: Create an Administrator profile 162
Step 3: Create the REST API Admin 164
Your First API Request 166
Filtering : 168
AAA Server 170
GET /settings/integration/aaa-mappings 171
Description 171
Request Headers 171
Sample Request 171
Sample Response 172
Get /settings/integration/aaa-mappings/local-domains 173
Description 173
Request Headers 173
Sample Request 173
Sample Response 174
POST /settings/integration/aaa-mappings/local-domains/delete 175
Description 175
Request Headers 175
Request Body Parameters 175
Sample Request 175
Sample Response 176
GET /settings/integration/aaa-mappings/defaults 177
Description 177
Request Headers 177
Sample Request 177
Sample Response 178
POST /settings/integration/aaa-mappings/local-domains 179
Description 179
Request Headers 179
Sample Request 179
Sample Response 180
POST /settings/integration/aaa-mappings 181
Description 181
Request Headers 181
Request Body Parameters 181
Sample Request 181

FortiNAC F 7.4.0 REST API 3

Fortinet Inc.
 Sample Response 182
POST /settings/integration/aaa-mappings/defaults 183
Description 183
Request Headers 183
Request Body Parameters 183
Sample Request 184
Sample Response 184
POST /settings/integration/aaa-mappings/delete 185
Description 185
Request Headers 185
Sample Request 185
Sample Response 186
POST /settings/integration/aaa-mappings/swap 187
Description 187
Request Headers 187
Request Body Parameters 187
Sample Request 187
Sample Response 188
Access Point Management 189
Get /settings/device/access-point-management 190
Description 190
Request Headers 190
Sample Request 190
Sample Response 191
Get /settings/device/access-point-management/ip-ranges 192
Description 192
Request Headers 192
Sample Request 192
Sample Response 193
POST /settings/device/access-point-management 194
Description 194
Request Headers 194
Request Body Parameters 194
Sample Request 194
Sample Response 195
Post /settings/device/access-point-management/ip-ranges 196
Description 196
Request Headers 196
Request Body Parameters 196
Sample Request 196
Sample Response 197

FortiNAC F 7.4.0 REST API 4

Fortinet Inc.
 Post /settings/device/access-point-management/ip-ranges/delete 198
Description 199
Path Parameter 199
Request Headers 199
Request Body Parameters 199
Sample Request 199
Sample Response 200
Post /settings/device/access-point-management/ip-ranges/{id} 201
Description 201
Request Parameter 201
Request Headers 201
Request Body Parameters 201
Sample Request 202
Sample Response 202
Post /settings/device/access-point-management/ip-ranges/bulk 203
Description 203
Request Headers 203
Request Body Parameters 203
Sample Request 203
Sample Response 204
Adapter Record 205
Delete /adapter/{id} 206
Description 206
Parameter 206
Request Headers 206
Sample Request 206
Sample Response 207
Get /adapter 208
Description 208
Request Headers 208
Request Body Parameters 208
Sample Request 208
Sample Response 209
Get /adapter/count 212
Description 212
Request Headers 212
Request Body Parameters 212
Sample Request 212
Sample Response 213
Get /adapter/count/all 214
Description 214
Request Headers 214
Sample Request 214

FortiNAC F 7.4.0 REST API 5

Fortinet Inc.
 Sample Response 215
Get /adapter/{id} 216
Description 216
Request Parameter 216
Request Headers 216
Sample Request 216
Sample Response 217
Get /adapter/{id}/usage 220
Description 220
Request Headers 220
Parameter 220
Sample Request 220
Sample Response 221
Get /adapter/connected-to-ports 222
Description 222
Request Headers 222
Request Body Parameters 222
Sample Request 222
Sample Response 223
Get /adapter/for-host 226
Description 226
Request Headers 226
Request Body Parameters 226
Sample Request 226
Sample Response 227
Get /adapter/{id}/get-port 230
Description 230
Request Parameter 230
Request Headers 230
Sample Request 230
Sample Response 231
Post /adapter 232
Description 232
Request Headers 232
Sample Request 232
Sample Response 245
Post /adapter/delete 247
Description 247
Request Headers 247
Request Body Parameters 247
Sample Request 247
Sample Response 248

FortiNAC F 7.4.0 REST API 6

Fortinet Inc.
 Post /adapter/{id} 249
Description 249
Parameter 249
Request Headers 249
Sample Request 249
Sample Response 262
Post /adapter/{id}/delete 264
Description 264
Request Parameter 264
Request Headers 264
Sample Request 264
Sample Response 265
Post /adapter/reprofile-rogues 266
Description 266
Request Headers 266
Request Body Parameters 266
Sample Request 266
Sample Response 267
Post /adapter/{id}/enable 268
Description 268
Request Parameter 268
Request Headers 268
Sample Request 268
Sample Response 269
Post /adapter/{id}/disable 270
Description 270
Request Parameter 270
Request Headers 270
Sample Request 270
Sample Response 271
Post /adapter/run-nmap-scan 272
Description 272
Request Headers 272
Request Body Parameters 272
Sample Request 272
Sample Response 273
Agent Update 274
Get /settings/agent/agent-update 275
Description 275
Request Headers 275
Sample Request 275
Sample Response 276

FortiNAC F 7.4.0 REST API 7

Fortinet Inc.
 Post /settings/agent/agent-update 277
Description 277
Request Headers 277
Sample Request 277
Sample Response 278
Post /settings/agent/agent-update/reset-counter 279
Description 279
Request Headers 279
Sample Request 279
Sample Response 280
Aging 281
Get /host/aging 282
Description 282
Request Headers 282
Sample Request 282
Sample Response 283
Post /host/aging 284
Description 284
Request Headers 284
Request Body Parameters 284
Sample Request 285
Sample Response 285
Post /host/aging/clear-registered 286
Description 286
Request Headers 286
Sample Request 286
Sample Response 287
Post /host/aging/clear-unregistered 288
Description 288
Request Headers 288
Sample Request 288
Sample Response 289
Post /host/aging/clear-users 290
Description 290
Request Headers 290
Sample Request 290
Sample Response 291
Allowed Domains 292
Get /settings/device/allowed-domains 293
Description 293
Request Headers 293
Sample Request 293
Sample Response 294

FortiNAC F 7.4.0 REST API 8

Fortinet Inc.
 Post /settings/device/allowed-domains 295
Description 295
Request Headers 295
Sample Request 295
Sample Response 296
Post /settings/device/allowed-domains/reset 297
Description 297
Request Headers 297
Sample Request 297
Sample Response 298
Analytics 299
Get /system/analytics-properties 300
Description 300
Request Headers 300
Sample Request 300
Sample Response 301
Post /system/analytics-properties 302
Description 302
Request Headers 302
Request Body Parameters 302
Sample Request 302
Sample Response 303
Authentication Configuration 304
Delete /policy/authentication-configuration/{id} 305
Description 305
Parameters 305
Request Headers 305
Sample Request 305
Sample Response 306
Get /policy/authentication-configuration 307
Description 307
Request Headers 307
Request Body Parameters 307
Sample Request 307
Sample Response 308
Get /policy/authentication-configuration/{id} 309
Description 309
Parameters 309
Request Headers 309
Sample Request 309
Sample Response 310
Get /policy/authentication-configuration/{id}/usage 311
Description 311

FortiNAC F 7.4.0 REST API 9

Fortinet Inc.
 Parameters 311
Request Headers 311
Sample Request 311
Sample Response 312
Post /policy/authentication-configuration 313
Description 313
Request Headers 313
Sample Request 313
Sample Response 314
Post /policy/authentication-configuration/delete 315
Description 315
Request Headers 315
Request Body Parameters 315
Sample Request 315
Sample Response 316
Post /policy/authentication-configuration/{id} 317
Description 317
Parameters 317
Request Headers 317
Sample Request 317
Sample Response 318
Post /policy/authentication-configuration/{id}/delete 319
Description 319
Request Headers 319
Request Body Parameters 319
Sample Request 319
Sample Response 320
Authentication Policy 321
Delete /policy/authentication/{id} 322
Description 322
Parameters 322
Request Headers 322
Sample Request 322
Sample Response 323
Get /policy/authentication 324
Description 324
Request Headers 324
Request Body Parameters 324
Sample Request 324
Sample Response 325
Get /policy/authentication/{id} 328
Description 328
Parameters 328

FortiNAC F 7.4.0 REST API 10

Fortinet Inc.
 Request Headers 328
Sample Request 328
Sample Response 329
Post /policy/authentication 332
Description 332
Request Headers 332
Request Body Parameters 332
Sample Request 332
Sample Response 333
Post /policy/authentication/delete 334
Description 334
Request Headers 334
Request Body Parameters 334
Sample Request 334
Sample Response 335
Post /policy/authentication/disable 336
Description 336
Request Headers 336
Request Body Parameters 336
Sample Request 336
Sample Response 337
Post /policy/authentication/enable 338
Description 338
Request Headers 338
Request Body Parameters 338
Sample Request 338
Sample Response 339
Post /policy/authentication/{id} 340
Description 340
Parameters 340
Request Headers 340
Sample Request 340
Sample Response 341
Post /policy/authentication/{id}/delete 342
Description 342
Parameters 342
Request Headers 342
Sample Request 342
Sample Response 343
Post /policy/authentication/{id}/disable 344
Description 344
Parameters 344
Request Headers 344

FortiNAC F 7.4.0 REST API 11

Fortinet Inc.
 Sample Request 344
Sample Response 345
Post /policy/authentication/{id}/enable 346
Description 346
Parameters 346
Request Headers 346
Sample Request 346
Sample Response 347
Post /policy/authentication/rank/set 348
Description 348
Request Headers 348
Request Body Parameters 348
Sample Request 348
Sample Response 349
Post /policy/authentication/rank/swap 350
Description 350
Request Headers 350
Request Body Parameters 350
Sample Request 350
Sample Response 351
Background Task 352
Get /system/background-task 353
Description 353
Request Headers 353
Request Body Parameters 353
Sample Request 353
Sample Response 354
Get /system/background-task/current-user 355
Description 355
Request Headers 355
Request Body Parameters 355
Sample Request 355
Sample Response 356
Get /system/background-task/{id} 357
Description 357
Parameters 357
Request Headers 357
Sample Request 357
Sample Response 358
Post /system/background-task 359
Description 359
Sample Request 359
Sample Response 360

FortiNAC F 7.4.0 REST API 12

Fortinet Inc.
 Post /system/background-task/{id} 361
Description 361
Parameters 361
Request Headers 361
Sample Request 361
Sample Response 362
Post /system/background-task/{id}/complete 363
Description 363
Parameters 363
Request Headers 363
Sample Request 363
Sample Response 364
Post /system/background-task/delete 365
Description 365
Request Headers 365
Request Body Parameters 365
Sample Request 365
Sample Response 366
Certificate 367
Get /settings/security/certificate-server 368
Description 368
Request Headers 368
Request Body Parameters 368
Sample Request 368
Sample Response 369
Post /settings/security/certificate-server/copy 372
Description 372
Request Headers 372
Request Body Parameters 372
Sample Request 372
Sample Response 373
Post /settings/security/certificate-server/csr/generate 374
Description 374
Request Headers 374
Sample Request 374
Sample Response 375
Post /settings/security/certificate-server/{name} 376
Description 376
Request Parameter 376
Request Body Parameters 376
Request Headers 376
Sample Request 377
Sample Response 377

FortiNAC F 7.4.0 REST API 13

Fortinet Inc.
 Post /settings/security/certificate-server/{name}/delete 378
Description 378
Request Parameter 378
Request Headers 378
Request Body Parameters 378
Sample Request 378
Sample Response 379
Post /settings/security/certificate-server/{name}/deleteServerCert 380
Description 380
Request Parameter 380
Request Headers 380
Sample Request 380
Sample Response 381
Post /settings/security/certificate-server/restart 382
Description 382
Request Headers 382
Request Body Parameters 382
Sample Request 382
Sample Response 383
Connection Log 384
Get /logging/connection 385
Description 385
Request Headers 385
Request Body Parameters 385
Sample Request 385
Sample Response 386
Get /logging/connection/count/all 387
Description 387
Request Headers 387
Sample Request 387
Sample Response 388
Get /logging/connection/archive 389
Description 389
Request Headers 389
Sample Request 389
Sample Response 390
Get /logging/connection/archive/import/status 391
Description 391
Request Headers 391
Sample Request 391
Sample Response 392
Get /logging/connection/by-session 393
Description 393

FortiNAC F 7.4.0 REST API 14

Fortinet Inc.
 Request Headers 393
Request Body Parameters 393
Sample Request 393
Sample Response 394
Get /logging/connection/count 395
Description 395
Request Headers 395
Request Body Parameters 395
Sample Request 395
Sample Response 396
Get /logging/connection/{id} 397
Description 397
Parameter 397
Request Headers 397
Sample Request 397
Sample Response 398
Get /logging/connection/tabledatatotals 399
Description 399
Request Headers 399
Request Body Parameters 399
Sample Request 399
Sample Response 400
Get /logging/connection/top/hosts/activity 401
Description 401
Request Headers 401
Request Body Parameters 401
Sample Request 401
Sample Response 402
Get /logging/connection/top/users/connected-time 403
Description 403
Request Headers 403
Request Body Parameters 403
Sample Request 403
Sample Response 404
Get /logging/connection/vlan/changes 405
Description 405
Request Headers 405
Request Body Parameters 405
Sample Request 405
Sample Response 406
Post /logging/connection/archive/import 407
Description 407
Request Headers 407

FortiNAC F 7.4.0 REST API 15

Fortinet Inc.
 Request Body Parameters 407
Sample Request 407
Sample Response 408
Container 409
Delete /device/container/{id} 410
Description 410
Parameters 410
Request Headers 410
Sample Request 410
Sample Response 411
Get /device/container 412
Description 412
Request Headers 412
Request Body Parameters 412
Sample Request 412
Sample Response 413
Get /device/container/count 416
Description 416
Request Headers 416
Request Body Parameters 416
Sample Request 416
Sample Response 417
Get /device/container/count/all 420
Description 420
Request Headers 420
Sample Request 420
Sample Response 421
Get /device/container/{id} 424
Description 424
Parameter 424
Request Headers 424
Sample Request 424
Sample Response 425
Get /device/container/{id}/usage 428
Description 428
Parameters 428
Request Headers 428
Sample Request 428
Sample Response 429
Get /device/container/monitor/{id} 430
Description 430
Parameters 430
Request Headers 430

FortiNAC F 7.4.0 REST API 16

Fortinet Inc.
 Sample Request 430
Sample Response 431
Post /device/container 432
Description 432
Request Headers 432
Sample Request 432
Sample Response 433
Post /device/container/{id} 434
Description 434
Parameter 434
Request Headers 434
Sample Request 434
Sample Response 435
Post /device/container/delete 436
Description 436
Parameters 436
Request Headers 436
Sample Request 436
Sample Response 437
Post /device/container/{id}/delete 438
Description 438
Parameters 438
Request Headers 438
Sample Request 438
Sample Response 439
Post /device/container/monitor/start 440
Description 440
Parameters 440
Request Headers 440
Sample Request 440
Sample Response 442
Post /device/container/monitor/{id}/stop 443
Description 443
Parameters 443
Request Headers 443
Sample Request 443
Sample Response 444
Credential Config 445
Get /settings/agent/credential-config 446
Description 446
Request Headers 446
Sample Request 446
Sample Response 447

FortiNAC F 7.4.0 REST API 17

Fortinet Inc.
 Post /settings/agent/credential-config 448
Description 448
Request Headers 448
Sample Request 448
Sample Response 449
Dashboard 450
Delete /user/dashboard/{id} 451
Description 451
Parameter 451
Request Headers 451
Sample Request 451
Sample Response 452
Get /user/dashboard/agent-summary 453
Description 453
Request Headers 453
Sample Request 453
Sample Response 454
Get /user/dashboard/device-summary 455
Description 455
Request Headers 455
Sample Request 455
Sample Response 456
Post /user/dashboard/device-summary/device/{tag}/{status} 457
Description 457
Request Headers 457
Parameters 457
Sample Request 457
Sample Response 458
Get /user/dashboard/device-summary/port/offline 459
Description 459
Request Headers 459
Sample Request 459
Sample Response 460
Get /user/dashboard/device-summary/port/online 461
Description 461
Request Headers 461
Sample Request 461
Sample Response 462
Get /user/dashboard/{id}/usage 463
Description 463
Parameter 463
Request Headers 463
Sample Request 463

FortiNAC F 7.4.0 REST API 18

Fortinet Inc.
 Sample Response 464
Get /user/dashboard/scan-summary/per-day 465
Description 465
Request Headers 465
Request Body Parameters 465
Sample Request 465
Sample Response 466
Get /user/dashboard/scan-summary/per-hour 467
Description 467
Request Headers 467
Request Body Parameters 467
Sample Request 467
Sample Response 468
Get /user/dashboard/host-summary 469
Description 469
Request Headers 469
Sample Request 469
Sample Response 470
Get /user/dashboard/user-summary 471
Description 471
Request Headers 471
Sample Request 471
Sample Response 472
Get /user/dashboard 473
Description 473
Request Headers 473
Request Body Parameters 473
Sample Request 473
Sample Response 474
Get /user/dashboard/{id} 476
Description 476
Parameter 476
Request Headers 476
Sample Request 476
Sample Response 477
Post /user/dashboard/delete 479
Description 479
Request Headers 479
Request Body Parameters 479
Sample Request 479
Sample Response 480
Post /user/dashboard/{id}/delete 481
Description 481

FortiNAC F 7.4.0 REST API 19

Fortinet Inc.
 Parameter 481
Request Headers 481
Sample Request 481
Sample Response 482
Post /user/dashboard/{id}/resetToDefault 483
Description 483
Parameter 483
Request Headers 483
Sample Request 483
Sample Response 484
Post /user/dashboard 485
Description 485
Request Headers 485
Sample Request 485
Sample Response 486
Post /user/dashboard/{id} 487
Description 487
Parameter 487
Request Headers 487
Sample Request 487
Sample Response 489
Post /user/dashboard/rank/set 491
Description 491
Request Headers 491
Request Body Parameters 491
Sample Request 491
Sample Response 492
Device Identity 493
Delete /host/device-identity/{id} 494
Description 494
Request Parameter 494
Request Headers 494
Sample Request 494
Sample Response 495
Get /host/device-identity 496
Description 496
Request Headers 496
Request Body Parameters 496
Sample Request 496
Sample Response 497
Get /host/device-identity/count 498
Description 498
Request Headers 498

FortiNAC F 7.4.0 REST API 20

Fortinet Inc.
 Request Body Parameters 498
Sample Request 498
Sample Response 499
Get /host/device-identity/count/all 502
Description 502
Request Headers 502
Sample Request 502
Sample Response 503
Get /host/device-identity/{id} 506
Description 506
Request Parameter 506
Request Headers 506
Sample Request 506
Sample Response 507
Get /host/device-identity/{id}/usage 508
Description 508
Parameter 508
Request Headers 508
Sample Request 508
Sample Response 509
Get /host/device-identity/fingerprints 510
Description 510
Request Headers 510
Request Body Parameters 510
Sample Request 510
Sample Response 511
Get /host/device-identity/fingerprint/{id} 512
Description 512
Request Headers 512
Request Body Parameters 512
Sample Request 512
Sample Response 513
Post /host/device-identity 514
Description 514
Request Headers 514
Request Body Parameters 514
Sample Request 514
Sample Response 515
Post /host/device-identity/delete 516
Description 516
Request Headers 516
Request Body Parameters 516
Sample Request 516

FortiNAC F 7.4.0 REST API 21

Fortinet Inc.
 Sample Response 517
Post /host/device-identity/{id} 518
Description 518
Request Parameter 518
Request Headers 518
Sample Request 518
Sample Response 519
Post /host/device-identity/{id}/delete 520
Description 520
Parameter 520
Request Headers 520
Sample Request 520
Sample Response 521
Post /host/device-identity/confirm-rule 522
Description 522
Request Headers 522
Request Body Parameters 522
Sample Request 522
Sample Response 523
Device Identity Source 524
Delete /host/device-identity-source/{id} 525
Description 525
Paramter 525
Request Headers 525
Sample Request 525
Sample Response 526
Get /host/device-identity-source 527
Description 527
Request Headers 527
Request Body Parameters 527
Sample Request 527
Sample Response 528
Get /host/device-identity-source/{id} 529
Description 529
Request Headers 529
Paramter 529
Sample Request 529
Sample Response 530
Post /host/device-identity-source 531
Description 531
Request Headers 531
Sample Request 531
Sample Response 532

FortiNAC F 7.4.0 REST API 22

Fortinet Inc.
 Post /host/device-identity-source/delete 533
Description 533
Request Headers 533
Request Body Parameters 533
Sample Request 533
Sample Response 534
Post /host/device-identity-source/{id} 535
Description 535
Parameter 535
Request Headers 535
Sample Request 535
Sample Response 536
Post /host/device-identity-source/{id}/delete 537
Description 537
Parameter 537
Request Headers 537
Sample Request 537
Sample Response 538
Post /host/device-identity-source/{id}/disable 539
Description 539
Parameter 539
Request Headers 539
Sample Request 539
Sample Response 540
Post /host/device-identity-source/{id}/enable 541
Description 541
Parameter 541
Request Headers 541
Sample Request 541
Sample Response 542
Post /host/device-identity-source/rank/set 543
Description 543
Request Headers 543
Request Body Parameters 543
Sample Request 543
Sample Response 544
Post /host/device-identity-source/rank/swap 545
Description 545
Request Headers 545
Request Body Parameters 545
Sample Request 545
Sample Response 546

FortiNAC F 7.4.0 REST API 23

Fortinet Inc.
 Device Mgmt Api Connector 547
Delete /settings/integration/device-mgmt-api/{id} 548
Description 548
Request Parameter 548
Request Headers 548
Sample Request 548
Sample Response 549
Get /settings/integration/device-mgmt-api 550
Description 550
Request Headers 550
Request Body Parameters 550
Sample Request 550
Sample Response 551
Get /settings/integration/device-mgmt-api/{id} 553
Description 553
Request Parameter 553
Request Headers 553
Sample Request 553
Sample Response 554
Get /settings/integration/device-mgmt-api/{id}/usage 556
Description 556
Request Parameter 556
Request Headers 556
Sample Request 556
Sample Response 557
Post /settings/integration/device-mgmt-api 558
Description 558
Request Headers 558
Sample Request 558
Sample Response 559
Post /settings/integration/device-mgmt-api/delete 560
Description 560
Request Headers 560
Request Body Parameters 560
Sample Request 560
Sample Response 561
Post /settings/integration/device-mgmt-api/{id} 562
Description 562
Request Parameter 562
Request Headers 562
Sample Request 562
Sample Response 564

FortiNAC F 7.4.0 REST API 24

Fortinet Inc.
 Post /settings/integration/device-mgmt-api/{id}/test 565
Description 565
Request Parameter 565
Request Headers 565
Sample Request 565
Sample Response 566
Post /settings/integration/device-mgmt-api/{id}/poll 567
Description 567
Request Parameter 567
Request Headers 567
Sample Request 567
Sample Response 568
Device Profiler 569
Get /DeviceProfiler/Rule/export 570
Description 570
Request Headers 570
Sample Request 570
Sample Response 571
Get /settings/device/device-profiler 574
Description 574
Request Headers 574
Sample Request 574
Sample Response 575
Post /settings/device/device-profiler 576
Description 576
Request Headers 576
Request Body Parameters 576
Sample Request 577
Sample Response 577
Directory Agent Config 578
Delete /settings/agent/directory-agent/{id} 579
Description 579
Parameters 579
Request Headers 579
Sample Request 579
Sample Response 580
Get /settings/agent/directory-agent 581
Description 581
Request Headers 581
Request Body Parameters 581
Sample Request 581
Sample Response 582

FortiNAC F 7.4.0 REST API 25

Fortinet Inc.
 Get /settings/agent/directory-agent/directory-groups 584
Description 584
Request Headers 584
Sample Request 584
Sample Response 585
Get /settings/agent/directory-agent/groups 586
Description 586
Request Headers 586
Sample Request 586
Sample Response 587
Get /settings/agent/directory-agent/{id} 588
Description 588
Parameters 588
Request Headers 588
Sample Request 588
Sample Response 589
Get /settings/agent/directory-agent/{id}/usage 592
Description 592
Parameters 592
Request Headers 592
Sample Request 592
Sample Response 593
Get /settings/agent/directory-agent/subnet 594
Description 594
Request Headers 594
Sample Request 594
Sample Response 595
Get /settings/agent/directory-agent/subnet/test 596
Description 596
Parameters 596
Request Headers 596
Sample Request 596
Sample Response 597
Post /settings/agent/directory-agent 598
Description 598
Request Headers 598
Sample Request 598
Sample Response 600
Post /settings/agent/directory-agent/delete 601
Description 601
Request Headers 601
Request Body Parameters 601
Sample Request 601

FortiNAC F 7.4.0 REST API 26

Fortinet Inc.
 Sample Response 602
Post /settings/agent/directory-agent/{id} 603
Description 603
Parameters 603
Request Headers 603
Sample Request 603
Sample Response 605
Post /settings/agent/directory-agent/{id}/delete 606
Description 606
Parameters 606
Request Headers 606
Sample Request 606
Sample Response 607
Post /settings/agent/directory-agent/subnet 608
Description 608
Request Headers 608
Request Body Parameters 608
Sample Request 608
Sample Response 609
Post /settings/agent/directory-agent/{id}/disable 610
Description 610
Parameters 610
Request Headers 610
Sample Request 610
Sample Response 611
Post /settings/agent/directory-agent/test 612
Description 612
Request Headers 612
Request Body Parameters 612
Sample Request 612
Sample Response 613
Post /settings/agent/directory-agent/rank/swap 614
Description 614
Request Headers 614
Request Body Parameters 614
Sample Request 614
Sample Response 615
Post /settings/agent/directory-agent/subnet/delete 616
Description 616
Request Headers 616
Request Body Parameters 616
Sample Request 616
Sample Response 617

FortiNAC F 7.4.0 REST API 27

Fortinet Inc.
 Post /settings/agent/directory-agent/rank/set 618
Description 618
Request Headers 618
Request Body Parameters 618
Sample Request 618
Sample Response 619
Post /settings/agent/directory-agent/{id}/enable 620
Description 620
Parameters 620
Request Headers 620
Sample Request 620
Sample Response 621
Discovery 622
Get /device/discovery/discover/status/all 623
Description 623
Request Headers 623
Sample Request 623
Sample Response 624
Get /device/discovery/discover/status 625
Description 625
Request Headers 625
Request Body Parameters 625
Sample Request 625
Sample Response 626
Post /device/discovery/discover/stop 627
Description 627
Request Headers 627
Request Body Parameters 627
Sample Request 627
Sample Response 628
Post /device/discovery/discover 629
Description 629
Request Headers 629
Sample Request 629
Sample Response 631
Endpoint Compliance Custom Scan 632
Get /policy/endpoint-compliance/custom-scan/html 633
Description 633
Request Headers 633
Request Body Parameters 633
Sample Response 634
Get /policy/endpoint-compliance/custom-scan 635
Description 635

FortiNAC F 7.4.0 REST API 28

Fortinet Inc.
 Request Headers 635
Sample Request 635
Sample Response 636
Get /policy/endpoint-compliance/custom-scan/usage 637
Description 637
Request Headers 637
Request Body Parameters 637
Sample Response 638
Post /policy/endpoint-compliance/custom-scan/custom-scan 639
Description 639
Request Headers 639
Request Body Parameters 639
Sample Request 640
Sample Response 640
Post /policy/endpoint-compliance/custom-scan/custom-scan/delete 641
Description 641
Request Headers 641
Request Body Parameters 641
Sample Request 641
Sample Response 642
Event Action 643
Get /policy/event-action 644
Description 644
Request Headers 644
Request Body Parameters 644
Sample Request 644
Sample Response 645
Get /policy/event-action/{id}/usage 646
Description 646
Request Parameter 646
Request Headers 646
Sample Request 646
Sample Response 647
Get /policy/event-action/supporting-info 648
Description 648
Request Headers 648
Sample Request 648
Sample Response 649
Get /policy/event-action/{id} 650
Description 650
Parameter 650
Request Headers 650
Sample Request 650

FortiNAC F 7.4.0 REST API 29

Fortinet Inc.
 Sample Response 651
Post /policy/event-action 654
Description 654
Request Headers 654
Sample Request 654
Sample Response 656
Post /policy/event-action/delete 657
Description 657
Request Headers 657
Request Body Parameters 657
Sample Request 657
Sample Response 658
Post /policy/event-action/{id}/delete 659
Description 659
Parameter 659
Request Headers 659
Sample Request 659
Sample Response 660
Post /policy/event-action/{id} 661
Description 661
Parameter 661
Request Headers 661
Sample Request 661
Sample Response 663
Delete /policy/event-action/{id} 664
Description 664
Parameter 664
Request Headers 664
Sample Request 664
Sample Response 665
FingerPrint 666
Get /host/fingerprint 667
Description 667
Request Headers 667
Request Body Parameters 667
Sample Request 667
Sample Response 668
Get /host/fingerprint/count 669
Description 669
Request Headers 669
Request Body Parameter 669
Sample Request 669
Sample Response 670

FortiNAC F 7.4.0 REST API 30

Fortinet Inc.
 Get /host/fingerprint/count/all 671
Description 671
Request Headers 671
Sample Request 671
Sample Response 672
Get /host/fingerprint/{id} 673
Description 673
Request Parameter 673
Request Headers 673
Sample Request 673
Sample Response 674
Post /host/fingerprint/delete 675
Description 675
Request Headers 675
Request Body Parameters 675
Sample Request 675
Sample Response 676
Post /host/fingerprint/{id}/delete 677
Description 677
Request Parameter 677
Request Headers 677
Sample Request 677
Sample Response 678
Post /host/fingerprint/{id} 679
Description 679
Parameter 679
Request Headers 679
Sample Request 679
Sample Response 680
Post /host/fingerprint 681
Description 681
Request Headers 681
Sample Request 681
Sample Response 682
Delete /host/fingerprint/{id} 683
Description 683
Parameter 683
Request Headers 683
Sample Request 683
Sample Response 684
Firewall Session 685
Get /dynamic/dynamic-connection/{id} 686
Description 686

FortiNAC F 7.4.0 REST API 31

Fortinet Inc.
 Request Headers 686
Sample Request 686
Sample Response 687
Get /dynamic/dynamic-connection 688
Description 688
Request Headers 688
Request Body Parameters 688
Sample Request 688
Sample Response 689
Post /dynamic/dynamic-connection/polling/{id}/run 690
Description 690
Parameter 690
Request Headers 690
Sample Request 690
Sample Response 691
Get /dynamic/dynamic-connection/polling/{id} 692
Description 692
Parameter 692
Request Headers 692
Sample Request 692
Sample Response 693
Get /dynamic/dynamic-connection/host/{id} 694
Description 694
Parameter 694
Request Headers 694
Sample Request 694
Sample Response 695
Get /dynamic/dynamic-connection/{id}/usage 696
Description 696
Parameter 696
Request Headers 696
Sample Request 696
Sample Response 697
Post /dynamic/dynamic-connection/{id}/delete 698
Description 698
Parameter 698
Request Headers 698
Sample Request 698
Sample Response 699
Post /dynamic/dynamic-connection/polling/{id} 700
Description 700
Parameter 700
Request Headers 700

FortiNAC F 7.4.0 REST API 32

Fortinet Inc.
 Sample Request 700
Sample Response 701
Post /dynamic/dynamic-connection 702
Description 702
Request Headers 702
Sample Request 702
Sample Response 703
Post /dynamic/dynamic-connection/{id} 704
Description 704
Parameter 704
Request Headers 704
Sample Request 704
Sample Response 705
Post /dynamic/dynamic-connection/delete 706
Description 706
Request Headers 706
Request Body Parameters 706
Sample Request 706
Sample Response 707
Delete /dynamic/dynamic-connection/{id} 708
Description 708
Parameter 708
Request Headers 708
Sample Request 708
Sample Response 709
Firewall Tag 710
Get /settings/integration/firewall-tag 711
Description 711
Request Headers 711
Request Body Parameters 711
Sample Request 711
Sample Response 712
Get /settings/integration/firewall-tag/{id} 713
Description 713
Parameter 713
Request Headers 713
Sample Request 713
Sample Response 714
Get /settings/integration/firewall-tag/{id}/usage 715
Description 715
Parameter 715
Request Headers 715
Sample Request 715

FortiNAC F 7.4.0 REST API 33

Fortinet Inc.
 Sample Response 716
Post /settings/integration/firewall-tag/{id} 717
Description 717
Parameter 717
Request Headers 717
Sample Request 717
Sample Response 718
Post /settings/integration/firewall-tag 719
Description 719
Request Headers 719
Sample Request 719
Sample Response 720
Post /settings/integration/firewall-tag/delete 721
Description 721
Request Headers 721
Request Body Parameters 721
Sample Request 721
Sample Response 722
Post /settings/integration/firewall-tag/{id}/delete 723
Description 723
Parameter 723
Request Headers 723
Sample Request 723
Sample Response 724
Delete /settings/integration/firewall-tag/{id} 725
Description 725
Parameter 725
Request Headers 725
Sample Request 725
Sample Response 726
FortiGate Telemetry 727
Get /settings/security-fabric/{id}/usage 728
Description 728
Parameter 728
Request Headers 728
Sample Request 728
Sample Response 729
Get /settings/security-fabric 730
Description 730
Request Headers 730
Request Body Parameters 730
Sample Request 730
Sample Response 731

FortiNAC F 7.4.0 REST API 34

Fortinet Inc.
 Get /settings/security-fabric/{id} 732
Description 732
Parameter 732
Request Headers 732
Sample Request 732
Sample Response 733
Post /settings/security-fabric 734
Description 734
Request Headers 734
Sample Request 734
Sample Response 735
Post /settings/security-fabric/delete 736
Description 736
Request Headers 736
Request Body Parameters 736
Sample Request 736
Sample Response 737
Post /settings/security-fabric/{id}/delete 738
Description 738
Parameter 738
Request Headers 738
Sample Request 738
Sample Response 739
Post /settings/security-fabric/{id} 740
Description 740
Parameter 740
Request Headers 740
Sample Request 740
Sample Response 741
Delete /settings/security-fabric/{id} 742
Description 742
Parameter 742
Request Headers 742
Sample Request 742
Sample Response 743
FSSO 744
Get /settings/integration/FSSO 745
Description 745
Request Headers 745
Sample Request 745
Sample Response 746
Get /settings/integration/FSSO/password 747
Description 747

FortiNAC F 7.4.0 REST API 35

Fortinet Inc.
 Request Headers 747
Sample Request 747
Sample Response 748
Post /settings/integration/FSSO 749
Description 749
Request Headers 749
Request Body Parameters 749
Sample Request 749
Sample Response 750
Google 751
Get /settings/integration/google/domains 752
Description 752
Request Headers 752
Sample Request 752
Sample Response 753
Get /settings/integration/google/client-id 754
Description 754
Request Headers 754
Sample Request 754
Sample Response 755
Post /settings/integration/google/domains/set 756
Description 756
Request Headers 756
Request Body Parameters 756
Sample Request 756
Sample Response 757
Post /settings/integration/google/client-id 758
Description 758
Request Headers 758
Request Body Parameters 758
Sample Request 758
Sample Response 759
Post /settings/integration/google/domains/{id} 760
Description 760
Parameter 760
Request Headers 760
Request Body Parameters 760
Sample Request 760
Sample Response 761
Post /settings/integration/google/domains/delete 762
Description 762
Parameter 762
Request Headers 762

FortiNAC F 7.4.0 REST API 36

Fortinet Inc.
 Request Body Parameters 762
Sample Request 762
Sample Response 763
Post /settings/integration/google/domains 764
Description 764
Request Headers 764
Request Body Parameters 764
Sample Request 764
Sample Response 765
Guest Account 766
Get /user/guest/count 767
Description 767
Request Headers 767
Request Body Parameters 767
Sample Request 767
Sample Response 768
Get /user/guest 771
Description 771
Request Headers 771
Request Body Parameters 771
Sample Request 771
Sample Response 772
Get /user/guest/conference/registrations/count 775
Description 775
Request Headers 775
Request Body Parameters 775
Sample Request 775
Sample Response 776
Get /user/guest/count/all 777
Description 777
Request Headers 777
Sample Request 777
Sample Response 778
Get /user/guest/{id}/get-password 781
Description 781
Parameter 781
Request Headers 781
Sample Request 781
Sample Response 782
Get /user/guest/{id} 783
Description 783
Parameter 783
Request Headers 783

FortiNAC F 7.4.0 REST API 37

Fortinet Inc.
 Sample Request 783
Sample Response 784
Post /user/guest 787
Description 787
Request Headers 787
Request Body Parameters 787
Sample Request 787
Sample Response 790
Post /user/guest/bulk 791
Description 791
Request Headers 791
Request Body Parameters 791
Sample Request 791
Sample Response 794
Post /user/guest/{id}/delete 795
Description 795
Parameter 795
Request Headers 795
Sample Request 795
Sample Response 796
Post /user/guest/{id} 797
Description 797
Parameter 797
Request Headers 797
Sample Request 797
Sample Response 800
Post /user/guest/generate-password-from-template 801
Description 801
Request Headers 801
Request Body Parameters 801
Sample Request 801
Sample Response 802
Post /user/guest/{id}/disable 803
Description 803
Parameter 803
Request Headers 803
Sample Request 803
Sample Response 804
Post /user/guest/{id}/generate-password 805
Description 805
Parameter 805
Request Headers 805
Sample Request 805

FortiNAC F 7.4.0 REST API 38

Fortinet Inc.
 Sample Response 806
Post /user/guest/delete 807
Description 807
Request Headers 807
Request Body Parameters 807
Sample Request 807
Sample Response 808
Post /user/guest/{id}/enable 809
Description 809
Parameter 809
Request Headers 809
Sample Request 809
Sample Response 810
Post /user/guest/get-password 811
Description 811
Request Headers 811
Request Body Parameters 811
Sample Request 811
Sample Response 812
Post /user/guest/reset-password 813
Description 813
Request Headers 813
Request Body Parameters 813
Sample Request 813
Sample Response 814
Post /user/guest/send-email 815
Description 815
Request Headers 815
Request Body Parameters 815
Sample Request 815
Sample Response 816
Post /user/guest/conference 817
Description 817
Request Headers 817
Request Body Parameters 817
Sample Request 818
Sample Response 818
Post /user/guest/send-sms 819
Description 819
Request Headers 819
Request Body Parameters 819
Sample Request 819
Sample Response 820

FortiNAC F 7.4.0 REST API 39

Fortinet Inc.
 Delete /user/guest/{id} 821
Description 821
Parameter 821
Request Headers 821
Sample Request 821
Sample Response 822
Host Record 823
Get /host/by-ip/{ip} 824
Description 824
Parameter 824
Request Headers 824
Sample Request 824
Sample Response 825
Get /host/by-mac/{mac} 828
Description 828
Parameter 828
Request Headers 828
Sample Request 828
Sample Response 829
Get /host/count/all 832
Description 832
Request Headers 832
Sample Request 832
Sample Response 833
Get /host/device-types 834
Description 834
Request Headers 834
Sample Request 834
Sample Response 835
Get /host/connected-to-port 836
Description 836
Request Headers 836
Request Body Parameters 836
Sample Request 836
Sample Response 837
Get /host/{id} 838
Description 838
Parameter 838
Request Headers 838
Sample Request 838
Sample Response 839
Get /host/{id}/usage 840
Description 840

FortiNAC F 7.4.0 REST API 40

Fortinet Inc.
 Parameter 840
Request Headers 840
Sample Request 840
Sample Response 841
Get /host/count 842
Description 842
Request Headers 842
Request Body Parameters 842
Sample Request 842
Sample Response 843
Get /host/for-user 844
Description 844
Request Headers 844
Request Body Parameters 844
Sample Request 844
Sample Response 845
Get /host/global-allowed-hosts 846
Description 846
Request Headers 846
Sample Request 846
Sample Response 847
Get /host/client-filters/cached/{name} 848
Description 848
Request Parameter 848
Request Headers 848
Sample Request 848
Sample Response 849
Get /host/{id}/policy 852
Description 852
Request Headers 852
Request Body Parameters 852
Sample Request 852
Sample Response 853
Get /host/client-filters 856
Description 856
Request Parameter 856
Request Headers 856
Request Body Parameters 856
Sample Request 856
Sample Response 858
Get /host/recent 861
Description 861
Request Headers 861

FortiNAC F 7.4.0 REST API 41

Fortinet Inc.
 Request Body Parameters 861
Sample Request 861
Sample Response 862
Post /host/delete 863
Description 863
Request Headers 863
Request Body Parameters 863
Sample Request 863
Sample Response 864
Post /host/set-role 865
Description 865
Request Headers 865
Request Body Parameters 865
Sample Request 865
Sample Response 866
Post /host/{id} 867
Description 867
Parameter 867
Request Headers 867
Sample Request 867
Sample Response 891
Post /host/{id}/enable 892
Description 892
Parameter 892
Request Headers 892
Sample Request 892
Sample Response 893
Post /host/{id}/disable 894
Description 894
Parameter 894
Request Headers 894
Sample Request 894
Sample Response 895
Post /host/import-hosts 896
Description 896
Request Headers 896
Request Body Parameters 896
Sample Request 896
Sample Response 897
Post /host/with-adapters/{id} 898
Description 898
Paramter 898
Request Headers 898

FortiNAC F 7.4.0 REST API 42

Fortinet Inc.
 Sample Request 898
Sample Response 899
Post /host/{id}/set-health 900
Description 900
Parameter 900
Request Headers 900
Request Body Parameters 900
Sample Request 901
Sample Response 901
Post /host/{id}/delete 902
Description 902
Parameter 902
Request Headers 902
Sample Request 902
Sample Response 903
Post /host/set-expiration 904
Description 904
Request Headers 904
Request Body Parameters 904
Sample Request 904
Sample Response 905
Post /host/trigger-scan 906
Description 906
Request Headers 906
Request Body Parameters 906
Sample Request 906
Sample Response 907
Post /host/{id}/rescan-with-profile 908
Description 908
Request Parameter 908
Request Headers 908
Request Body Parameters 908
Sample Request 908
Sample Response 909
Post /host/send-persistent-agent-message 910
Description 910
Request Headers 910
Request Body Parameters 910
Sample Request 910
Sample Response 911
Post /host/{id}/update-persistent-agent 912
Description 912
Request Parameter 912

FortiNAC F 7.4.0 REST API 43

Fortinet Inc.
 Request Headers 912
Request Body Parameters 912
Sample Request 912
Sample Response 913
Post /host/accept-imported-hosts 914
Description 914
Request Headers 914
Sample Request 914
Sample Response 915
Delete /host/{id} 916
Description 916
Parameter 916
Request Headers 916
Sample Request 916
Sample Response 917
Host Registration Request 918
Get /host/registration-request 919
Description 919
Request Headers 919
Request Body Parameters 919
Sample Request 919
Sample Response 920
Get /host/registration-request/{id} 921
Description 921
Request Parameter 921
Request Headers 921
Sample Request 921
Sample Response 922
Post /host/registration-request/deny 923
Description 923
Request Headers 923
Sample Request 923
Sample Response 924
Post /host/registration-request/{id}/delete 925
Description 925
Parameter 925
Request Headers 925
Sample Request 925
Sample Response 926
Post /host/registration-request/delete 927
Description 927
Request Headers 927
Request Body Parameters 927

FortiNAC F 7.4.0 REST API 44

Fortinet Inc.
 Sample Request 927
Sample Response 928
Post /host/registration-request/approve 929
Description 929
Request Headers 929
Sample Request 929
Sample Response 930
Delete /host/registration-request/{id} 931
Description 931
Request Parameter 931
Request Headers 931
Sample Request 931
Sample Response 932
L3 Scan 933
Get /device/l3scan/status 934
Description 934
Request Headers 934
Sample Request 934
Sample Response 935
Post /device/l3scan/stop 936
Description 936
Request Headers 936
Sample Request 936
Sample Response 937
Post /device/l3scan/start 938
Description 938
Request Headers 938
Sample Request 938
Sample Response 939
Logical Network Configuration 940
Get /policy/logical-network-configuration/element/properties 941
Description 941
Request Headers 941
Request Body Parameters 941
Sample Request 941
Sample Response 942
Get /policy/logical-network-configuration 945
Description 945
Request Headers 945
Request Body Parameters 945
Sample Request 945
Sample Response 946

FortiNAC F 7.4.0 REST API 45

Fortinet Inc.
 Get /policy/logical-network-configuration/{id} 949
Description 949
Parameter 949
Request Headers 949
Sample Response 950
Get /policy/logical-network-configuration/{id}/usage 953
Description 953
Request Parameter 953
Request Headers 953
Sample Request 953
Sample Response 954
Get /policy/logical-network-configuration/radius 955
Description 955
Request Headers 955
Sample Request 955
Sample Response 956
Post /policy/logical-network-configuration 957
Description 957
Request Headers 957
Sample Request 957
Sample Response 959
Post /policy/logical-network-configuration/batch-upsert 960
Description 960
Request Headers 960
Sample Request 960
Sample Response 962
Post /policy/logical-network-configuration/element/properties 963
Description 963
Request Headers 963
Sample Request 963
Sample Response 968
Post /policy/logical-network-configuration/delete 969
Description 969
Request Headers 969
Request Body Parameters 969
Sample Request 969
Sample Response 970
Post /policy/logical-network-configuration/{id}/delete 971
Description 971
Request Parameter 971
Request Headers 971
Sample Request 971
Sample Response 972

FortiNAC F 7.4.0 REST API 46

Fortinet Inc.
 Post /policy/logical-network-configuration/{id} 973
Description 973
Parameter 973
Request Headers 973
Sample Request 973
Sample Response 975
Post /policy/logical-network-configuration/element/properties/{deviceID} 976
Description 976
Request Parameter 976
Request Headers 976
Sample Request 976
Sample Response 981
Delete /policy/logical-network-configuration/{id} 982
Description 982
Parameter 982
Request Headers 982
Sample Request 982
Sample Response 983
Mac Exclusion 984
Get /settings/device/mac-exclusion 985
Description 985
Request Headers 985
Sample Request 985
Sample Response 986
Post /settings/device/mac-exclusion/delete 987
Description 987
Request Headers 987
Request Body Parameters 987
Sample Request 987
Sample Response 988
Post /settings/device/mac-exclusion 989
Description 989
Request Headers 989
Request Body Parameters 989
Sample Request 989
Sample Response 990
Message Template 991
Get /settings/integration/message-template 992
Description 992
Request Headers 992
Request Body Parameters 992
Sample Request 992
Sample Response 993

FortiNAC F 7.4.0 REST API 47

Fortinet Inc.
 Get /settings/integration/message-template/{id} 994
Description 994
Request Parameter 994
Request Headers 994
Sample Request 994
Sample Response 995
Get /settings/integration/message-template/{id}/usage 996
Description 996
Request Parameter 996
Request Headers 996
Sample Request 996
Sample Response 997
Post /settings/integration/message-template/test 998
Description 998
Request Headers 998
Sample Request 998
Sample Response 999
Post /settings/integration/message-template/{id}/delete 1000
Description 1000
Request Parameter 1000
Request Headers 1000
Sample Request 1000
Sample Response 1001
Post /settings/integration/message-template/{id} 1002
Description 1002
Request Parameter 1002
Request Headers 1002
Sample Request 1002
Sample Response 1003
Post /settings/integration/message-template/delete 1004
Description 1004
Request Headers 1004
Request Body Parameters 1004
Sample Request 1004
Sample Response 1005
Post /settings/integration/message-template 1006
Description 1006
Request Headers 1006
Sample Request 1006
Sample Response 1007
Delete /settings/integration/message-template/{id} 1008
Description 1008
Request Parameter 1008

FortiNAC F 7.4.0 REST API 48

Fortinet Inc.
 Request Headers 1008
Sample Request 1008
Sample Response 1009
Messaging Gateway 1010
Get /settings/integration/messaging-gateway 1011
Description 1011
Request Headers 1011
Request Body Parameters 1011
Sample Request 1011
Sample Response 1012
Get /settings/integration/messaging-gateway/global/default-messaging-
gateway 1013
Description 1013
Request Headers 1013
Sample Request 1013
Sample Response 1014
Get /settings/integration/messaging-gateway/{id} 1015
Description 1015
Request Parameter 1015
Request Headers 1015
Sample Request 1015
Sample Response 1016
Get /settings/integration/messaging-gateway/count/all 1017
Description 1017
Request Headers 1017
Sample Request 1017
Sample Response 1018
Get /settings/integration/messaging-gateway/global/max-length 1019
Description 1019
Request Headers 1019
Sample Request 1019
Sample Response 1020
Get /settings/integration/messaging-gateway/count 1021
Description 1021
Request Headers 1021
Sample Request 1021
Sample Response 1022
Post /settings/integration/messaging-gateway/delete 1023
Description 1023
Request Headers 1023
Request Body Parameters 1023
Sample Request 1023
Sample Response 1024

FortiNAC F 7.4.0 REST API 49

Fortinet Inc.
 Post /settings/integration/messaging-gateway 1025
Description 1025
Request Headers 1025
Sample Request 1025
Sample Response 1026
Post /settings/integration/messaging-gateway/global/default-messaging-
gateway 1027
Description 1027
Request Headers 1027
Request Body Parameters 1027
Sample Response 1028
Post /settings/integration/messaging-gateway/global/max-length 1029
Description 1029
Request Headers 1029
Request Body Parameters 1029
Sample Response 1030
Post /settings/integration/messaging-gateway/{id} 1031
Description 1031
Request Parameter 1031
Request Headers 1031
Sample Request 1031
Sample Response 1032
Post /settings/integration/messaging-gateway/{id}/delete 1033
Description 1033
Request Parameter 1033
Request Headers 1033
Sample Request 1033
Sample Response 1034
Post /settings/integration/messaging-gateway/send-sms 1035
Description 1035
Request Headers 1035
Sample Request 1035
Sample Response 1036
Post /settings/integration/messaging-gateway/{id}/disable 1037
Description 1037
Request Parameter 1037
Request Headers 1037
Sample Request 1037
Sample Response 1038
Post /settings/integration/messaging-gateway/{id}/test 1039
Description 1039
Request Parameter 1039
Request Headers 1039

FortiNAC F 7.4.0 REST API 50

Fortinet Inc.
 Request Body Parameters 1039
Sample Request 1039
Sample Response 1040
Post /settings/integration/messaging-gateway/{id}/enable 1041
Description 1041
Request Parameter 1041
Request Headers 1041
Sample Request 1041
Sample Response 1042
Delete /settings/integration/messaging-gateway/{id} 1043
Description 1043
Request Parameter 1043
Request Headers 1043
Sample Request 1043
Sample Response 1044
Nat Detection 1045
Get /settings/device/NAT-detection 1046
Description 1047
Request Headers 1047
Sample Request 1047
Sample Response 1048
Post /settings/device/NAT-detection/ip-ranges 1049
Description 1050
Request Headers 1050
Request Body Parameters 1050
Sample Request 1050
Sample Response 1051
Post /settings/device/NAT-detection/ip-ranges/delete 1052
Description 1053
Request Headers 1053
Request Body Parameters 1053
Sample Request 1053
Sample Response 1054
Post /settings/device/NAT-detection/ip-ranges/{id} 1055
Description 1056
Request Parameter 1056
Request Headers 1056
Request Body Parameters 1056
Sample Request 1056
Sample Response 1057

FortiNAC F 7.4.0 REST API 51

Fortinet Inc.
 NCM-Operation 1058
AAA Server 1059
Delete /settings/integration/aaa/{id} 1060
Description 1060
Request Parameter 1060
Request Headers 1060
Sample Request 1060
Sample Response 1061
Get /settings/integration/aaa 1062
Description 1062
Request Headers 1062
Request Body Parameters 1062
Sample Request 1062
Sample Response 1063
Get /settings/integration/aaa/count 1064
Description 1064
Request Headers 1064
Request Body Parameters 1064
Sample Request 1064
Sample Response 1065
Get /settings/integration/aaa/count/all 1066
Description 1066
Request Headers 1066
Sample Request 1066
Sample Response 1067
Get /settings/integration/aaa/{id} 1068
Description 1068
Request Parameter 1068
Request Headers 1068
Sample Request 1068
Sample Response 1069
Get /settings/integration/aaa/{id}/secret 1070
Description 1070
Request Parameter 1070
Request Headers 1070
Sample Request 1070
Sample Response 1071
Get /settings/integration/aaa/supportsValidation 1072
Description 1072
Request Parameter 1072
Request Headers 1072
Sample Request 1072
Sample Response 1073

FortiNAC F 7.4.0 REST API 52

Fortinet Inc.
 Get /settings/integration/aaa/{id}/usage 1074
Description 1074
Request Parameter 1074
Request Headers 1074
Sample Request 1074
Sample Response 1075
Get /settings/integration/aaa/{id}/validate-user-password 1076
Description 1076
Request Parameter 1076
Request Headers 1076
Sample Request 1076
Sample Response 1077
Get /settings/integration/aaa/validate/{id} 1078
Description 1078
Request Parameter 1078
Request Headers 1078
Sample Request 1078
Sample Response 1079
Post /settings/integration/aaa 1080
Description 1080
Request Headers 1080
Sample Request 1080
Sample Response 1081
Post /settings/integration/aaa/delete 1082
Description 1082
Request Headers 1082
Request Body Parameters 1082
Sample Request 1082
Sample Response 1083
Post /settings/integration/aaa/{id}/delete 1084
Description 1084
Request Parameter 1084
Request Headers 1084
Sample Request 1084
Sample Response 1085
Post /settings/integration/aaa/{id} 1086
Description 1086
Request Parameter 1086
Request Headers 1086
Sample Request 1086
Sample Response 1087
Post /settings/integration/aaa/validate 1088
Description 1088

FortiNAC F 7.4.0 REST API 53

Fortinet Inc.
 Request Headers 1088
Sample Request 1088
Sample Response 1089
Access Configuration 1090
Delete /policy/access-configuration/{id} 1091
Description 1091
Request Parameter 1091
Request Headers 1091
Sample Request 1091
Sample Response 1092
Get /policy/access-configuration 1093
Description 1093
Request Headers 1093
Request Body Parameters 1093
Sample Request 1093
Sample Response 1094
Get /policy/access-configuration/count 1097
Description 1097
Request Headers 1097
Request Body Parameters 1097
Sample Request 1097
Sample Response 1098
Get /policy/access-configuration/count/all 1101
Description 1101
Request Headers 1101
Sample Request 1101
Sample Response 1102
Get /policy/access-configuration/direct-configuration 1105
Description 1105
Request Headers 1105
Sample Request 1105
Sample Response 1106
Get /policy/access-configuration/{id} 1107
Description 1107
Request Parameter 1107
Request Headers 1107
Sample Request 1107
Sample Response 1108
Get /policy/access-configuration/{id}/usage 1111
Description 1111
Request Parameter 1111
Request Headers 1111
Sample Request 1111

FortiNAC F 7.4.0 REST API 54

Fortinet Inc.
 Sample Response 1112
Get /policy/access-configuration/supporting-info 1113
Description 1113
Request Headers 1113
Sample Request 1113
Sample Response 1114
Post /policy/access-configuration 1117
Description 1117
Request Headers 1117
Sample Request 1117
Sample Response 1119
Post /policy/access-configuration/delete 1120
Description 1120
Request Headers 1120
Request Body Parameters 1120
Sample Request 1120
Sample Response 1121
Post /policy/access-configuration/{id} 1122
Description 1122
Request Parameter 1122
Request Headers 1122
Sample Request 1122
Sample Response 1124
Post /policy/access-configuration/{id}/delete 1125
Description 1125
Request Parameter 1125
Request Headers 1125
Sample Request 1125
Sample Response 1126
Access Policy 1127
Delete /policy/access/{id} 1128
Description 1128
Request Parameter 1128
Request Headers 1128
Sample Request 1128
Sample Response 1129
Get /policy/access 1130
Description 1130
Request Headers 1130
Request Body Parameters 1130
Sample Request 1130
Sample Response 1131

FortiNAC F 7.4.0 REST API 55

Fortinet Inc.
 Post /policy/access/disable 1134
Description 1134
Request Headers 1134
Request Body Parameters 1134
Sample Request 1134
Sample Response 1135
Get /policy/access/{id} 1136
Description 1136
Request Parameter 1136
Request Headers 1136
Sample Request 1136
Sample Response 1137
Get /policy/access/supporting-info 1140
Description 1140
Request Headers 1140
Sample Request 1140
Sample Response 1141
Post /policy/access 1144
Description 1144
Request Headers 1144
Sample Request 1144
Sample Response 1148
Post /policy/access/delete 1149
Description 1149
Request Headers 1149
Request Body Parameters 1149
Sample Request 1149
Sample Response 1150
Post /policy/access/enable 1151
Description 1151
Request Headers 1151
Request Body Parameters 1151
Sample Request 1151
Sample Response 1152
Post /policy/access/{id} 1153
Description 1153
Request Parameter 1153
Request Headers 1153
Sample Request 1153
Sample Response 1157
Post /policy/access/{id}/delete 1158
Description 1158
Request Parameter 1158

FortiNAC F 7.4.0 REST API 56

Fortinet Inc.
 Request Headers 1158
Sample Request 1158
Sample Response 1159
Post /policy/access/{id}/disable 1160
Description 1160
Request Parameter 1160
Request Headers 1160
Sample Request 1160
Sample Response 1161
Post /policy/access/{id}/enable 1162
Description 1162
Request Parameter 1162
Request Headers 1162
Sample Request 1162
Sample Response 1163
Post /policy/access/rank/set 1164
Description 1164
Request Headers 1164
Request Body Parameters 1164
Sample Request 1164
Sample Response 1165
Post /policy/access/rank/swap 1166
Description 1166
Request Headers 1166
Request Body Parameters 1166
Sample Request 1166
Sample Response 1167
Admin Profile 1168
Delete /user/admin-profile/{id} 1169
Description 1169
Request Parameter 1169
Request Headers 1169
Sample Request 1169
Sample Response 1170
Delete /user/admin-profile/mapping/{id} 1171
Description 1171
Request Parameter 1171
Request Headers 1171
Sample Request 1171
Sample Response 1172
Get /user/admin-profile 1173
Description 1173
Request Headers 1173

FortiNAC F 7.4.0 REST API 57

Fortinet Inc.
 Request Body Parameters 1173
Sample Request 1173
Sample Response 1174
Get /user/admin-profile/{id} 1177
Description 1177
Request Parameter 1177
Request Headers 1177
Sample Request 1177
Sample Response 1178
Get /user/admin-profile/{id}/usage 1181
Description 1181
Request Parameter 1181
Request Headers 1181
Sample Request 1181
Sample Response 1182
Get /user/admin-profile/mapping 1183
Description 1183
Request Headers 1183
Request Body Parameters 1183
Sample Request 1183
Sample Response 1184
Get /user/admin-profile/mapping/{id} 1186
Description 1186
Request Parameter 1186
Request Headers 1186
Sample Request 1186
Sample Response 1187
Get /user/admin-profile/mapping/supporting-info 1189
Description 1189
Request Headers 1189
Sample Request 1189
Sample Response 1190
Get /user/admin-profile/new 1191
Description 1191
Request Headers 1191
Sample Request 1191
Sample Response 1192
Get /user/admin-profile/permission-view-map 1195
Description 1195
Request Headers 1195
Sample Request 1195
Sample Response 1196

FortiNAC F 7.4.0 REST API 58

Fortinet Inc.
 Post /user/admin-profile 1197
Description 1197
Request Headers 1197
Sample Request 1197
Sample Response 1199
Post /user/admin-profile/delete 1200
Description 1200
Request Headers 1200
Request Body Parameters 1200
Sample Request 1200
Sample Response 1201
Post /user/admin-profile/{id} 1202
Description 1202
Request Parameter 1202
Request Headers 1202
Sample Request 1202
Sample Response 1204
Post /user/admin-profile/{id}/delete 1205
Description 1205
Request Parameter 1205
Request Headers 1205
Sample Request 1205
Sample Response 1206
Post /user/admin-profile/mapping 1207
Description 1207
Request Headers 1207
Sample Request 1207
Sample Response 1208
Post /user/admin-profile/mapping/delete 1209
Description 1209
Request Parameter 1209
Request Headers 1209
Request Body Parameters 1209
Sample Request 1209
Sample Response 1210
Post /user/admin-profile/mapping/{id} 1211
Description 1211
Request Parameter 1211
Request Headers 1211
Sample Request 1211
Sample Response 1213
Post /user/admin-profile/mapping/rank/set 1214
Description 1214

FortiNAC F 7.4.0 REST API 59

Fortinet Inc.
 Request Headers 1214
Request Body Parameters 1214
Sample Request 1214
Sample Response 1215
Post /user/admin-profile/mapping/rank/swap 1216
Description 1216
Request Headers 1216
Request Body Parameters 1216
Sample Request 1216
Sample Response 1217
Agent Packages 1218
Get /settings/agent/agent-packages 1219
Description 1219
Request Headers 1219
Sample Request 1219
Sample Response 1220
Get /settings/agent/agent-packages/available-agents 1221
Description 1221
Request Headers 1221
Sample Request 1221
Sample Response 1222
Post /settings/agent/agent-packages/{packageFile}/delete 1223
Description 1223
Request Parameter 1223
Request Headers 1223
Sample Request 1223
Sample Response 1224
Delete /settings/agent/agent-packages/{packageFile} 1225
Description 1225
Request Parameter 1225
Request Headers 1225
Sample Request 1225
Sample Response 1226
Alarm 1227
Get /logging/alarm 1228
Description 1228
Request Headers 1228
Request Body Parameters 1228
Sample Request 1228
Sample Response 1229
Get /logging/alarm/count 1230
Description 1230
Request Headers 1230

FortiNAC F 7.4.0 REST API 60

Fortinet Inc.
 Request Body Parameters 1230
Sample Request 1230
Sample Response 1231
Get /logging/alarm/count/all 1232
Description 1232
Request Headers 1232
Sample Request 1232
Sample Response 1233
Get /logging/alarm/archive 1234
Description 1234
Request Headers 1234
Sample Request 1234
Sample Response 1235
Get /logging/alarm/archive/import/status 1236
Description 1236
Request Headers 1236
Sample Request 1236
Sample Response 1237
Get /logging/alarm/{id} 1238
Description 1238
Request Parameter 1238
Request Headers 1238
Sample Request 1238
Sample Response 1239
Get /logging/alarm/{id}/usage 1240
Description 1240
Request Parameter 1240
Request Headers 1240
Sample Request 1240
Sample Response 1241
Get /logging/alarm/monitor/{id} 1242
Description 1242
Request Parameter 1242
Request Headers 1242
Sample Request 1242
Sample Response 1243
Get /logging/alarm/supporting-info 1244
Description 1244
Request Headers 1244
Sample Request 1244
Sample Response 1245
Post /logging/alarm/acknowledge 1246
Description 1246

FortiNAC F 7.4.0 REST API 61

Fortinet Inc.
 Request Headers 1246
Request Body Parameters 1246
Sample Request 1246
Sample Response 1247
Post /logging/alarm/{id}/delete 1248
Description 1248
Request Parameter 1248
Request Headers 1248
Sample Request 1248
Sample Response 1249
Post /logging/alarm/delete 1250
Description 1250
Request Headers 1250
Request Body Parameters 1250
Sample Request 1250
Sample Response 1251
Post /logging/alarm/archive/import 1252
Description 1252
Request Headers 1252
Request Body Parameters 1252
Sample Request 1252
Sample Response 1253
Post /logging/alarm/delete 1254
Description 1254
Request Headers 1254
Request Body Parameters 1254
Sample Request 1254
Sample Response 1255
Post /logging/alarm/{id}/acknowledge 1256
Description 1256
Request Parameter 1256
Request Headers 1256
Sample Request 1256
Sample Response 1257
Post /logging/alarm/{id}/delete 1258
Description 1258
Request Parameter 1258
Request Headers 1258
Sample Request 1258
Sample Response 1259
Post /logging/alarm/monitor/{id}/stop 1260
Description 1260
Request Parameter 1260

FortiNAC F 7.4.0 REST API 62

Fortinet Inc.
 Request Headers 1260
Sample Request 1260
Sample Response 1261
Post /logging/alarm/monitor/start 1262
Description 1262
Request Headers 1262
Sample Request 1262
Sample Response 1263
Delete /logging/alarm/{id} 1264
Description 1264
Request Parameter 1264
Request Headers 1264
Sample Request 1264
Sample Response 1265
Audit Log 1266
Get /logging/audit 1267
Description 1267
Request Headers 1267
Request Body Parameters 1267
Sample Request 1267
Sample Response 1268
Get /logging/audit/count 1269
Description 1269
Request Headers 1269
Request Body Parameters 1269
Sample Request 1269
Sample Response 1270
Backup Configuration 1271
Get /system/backup/configuration/ftp 1272
Description 1272
Request Headers 1272
Sample Request 1272
Sample Response 1273
Get /system/backup/configuration/sftp 1274
Description 1274
Request Headers 1274
Sample Request 1274
Sample Response 1275
Get /system/backup/configuration/ssh 1276
Description 1276
Request Headers 1276
Sample Request 1276
Sample Response 1277

FortiNAC F 7.4.0 REST API 63

Fortinet Inc.
 Post /system/backup/configuration/ftp 1278
Description 1278
Request Headers 1278
Sample Request 1278
Sample Response 1279
Post /system/backup/configuration/sftp 1280
Description 1280
Request Headers 1280
Sample Request 1280
Sample Response 1281
Post /system/backup/configuration/ssh 1282
Description 1282
Request Headers 1282
Sample Request 1282
Sample Response 1283
Backup Settings 1284
Get /system/backup-settings/archives 1285
Description 1285
Request Headers 1285
Sample Request 1285
Sample Response 1286
Get /system/backup-settings/database 1287
Description 1287
Request Headers 1287
Sample Request 1287
Sample Response 1288
Get /system/backup-settings/database/archive 1289
Description 1289
Request Headers 1289
Sample Request 1289
Sample Response 1290
Get /system/backup-settings/system-backup 1291
Description 1291
Request Headers 1291
Sample Request 1291
Sample Response 1292
Post /system/backup-settings/archives 1293
Description 1293
Request Headers 1293
Request Body Parameters 1293
Sample Request 1293
Sample Response 1294

FortiNAC F 7.4.0 REST API 64

Fortinet Inc.
 Post /system/backup-settings/database 1295
Description 1295
Request Headers 1295
Request Body Parameters 1295
Sample Request 1295
Sample Response 1296
Post /system/backup-settings/database/restore-archives 1297
Description 1297
Request Headers 1297
Request Body Parameters 1297
Sample Request 1297
Sample Response 1298
Post /system/backup-settings/system-backup 1299
Description 1299
Request Headers 1299
Request Body Parameters 1299
Sample Request 1299
Sample Response 1300
Device Profiling Rule 1301
Get /host/device-profiling-rule 1302
Description 1302
Request Headers 1302
Request Body Parameters 1302
Sample Request 1302
Sample Response 1303
Get /host/device-profiling-rule/count 1306
Description 1306
Request Headers 1306
Request Body Parameters 1306
Sample Request 1306
Sample Response 1307
Get /host/device-profiling-rule/count/all 1310
Description 1310
Request Headers 1310
Sample Request 1310
Sample Response 1311
Get /host/device-profiling-rule/create-from-adapter 1314
Description 1314
Request Headers 1314
Request Body Parameters 1314
Sample Request 1314
Sample Response 1315

FortiNAC F 7.4.0 REST API 65

Fortinet Inc.
 Get /host/device-profiling-rule/{id} 1318
Description 1318
Request Parameter 1318
Request Headers 1318
Sample Request 1318
Sample Response 1319
Get /host/device-profiling-rule/queue 1322
Description 1322
Request Headers 1322
Sample Request 1322
Sample Response 1323
Post /host/device-profiling-rule 1324
Description 1324
Request Headers 1324
Sample Request 1324
Sample Response 1326
Post /host/device-profiling-rule/delete 1327
Description 1327
Request Headers 1327
Request Body Parameters 1327
Sample Request 1327
Sample Response 1328
Post /host/device-profiling-rule/{id} 1329
Description 1329
Request Parameter 1329
Request Headers 1329
Sample Request 1329
Sample Response 1331
Post /host/device-profiling-rule/{id}/delete 1332
Description 1332
Request Parameter 1332
Request Headers 1332
Sample Request 1332
Sample Response 1333
Post /host/device-profiling-rule/{id}/disable 1334
Description 1334
Request Parameter 1334
Request Headers 1334
Sample Request 1334
Sample Response 1335
Post /host/device-profiling-rule/{id}/enable 1336
Description 1336
Request Parameter 1336

FortiNAC F 7.4.0 REST API 66

Fortinet Inc.
 Request Headers 1336
Sample Request 1336
Sample Response 1337
Get /host/device-profiling-rule/{id}/usage 1338
Description 1338
Request Parameter 1338
Request Headers 1338
Sample Request 1338
Sample Response 1339
Post /host/device-profiling-rule/scan 1340
Description 1340
Request Headers 1340
Sample Request 1340
Sample Response 1341
Post /host/device-profiling-rule/swap-rule-ranks 1342
Description 1342
Request Headers 1342
Request Body Parameters 1342
Sample Request 1342
Sample Response 1343
Post /host/device-profiling-rule/test 1344
Description 1344
Request Headers 1344
Request Body Parameters 1344
Sample Request 1344
Sample Response 1345
Delete /host/device-profiling-rule/{id} 1346
Description 1346
Request Headers 1346
Sample Request 1346
Sample Response 1347
Device Type 1348
Delete /settings/device/device-type/{id} 1349
Description 1349
Request Parameter 1349
Request Headers 1349
Sample Request 1349
Sample Response 1350
Get /settings/device/device-type 1351
Description 1351
Request Headers 1351
Request Body Parameters 1351
Sample Request 1351

FortiNAC F 7.4.0 REST API 67

Fortinet Inc.
 Sample Response 1352
Get /settings/device/device-type/{id} 1353
Description 1353
Request Parameter 1353
Request Headers 1353
Sample Request 1353
Sample Response 1354
Get /settings/device/device-type/{id}/usage 1355
Description 1355
Request Parameter 1355
Request Headers 1355
Sample Request 1355
Sample Response 1356
Get /settings/device/device-type/image/archive 1357
Description 1357
Request Headers 1357
Sample Request 1357
Sample Response 1358
Post /settings/device/device-type 1359
Description 1359
Request Headers 1359
Sample Request 1359
Sample Response 1360
Post /settings/device/device-type/createFromArchive 1361
Description 1361
Request Headers 1361
Request Body Parameters 1361
Sample Request 1361
Sample Response 1362
Post /settings/device/device-type/delete 1363
Description 1363
Request Headers 1363
Request Body Parameters 1363
Sample Request 1363
Sample Response 1364
Post /settings/device/device-type/{id} 1365
Description 1365
Request Parameter 1365
Request Headers 1365
Sample Request 1365
Sample Response 1366
Post /settings/device/device-type/{id}/delete 1367
Description 1367

FortiNAC F 7.4.0 REST API 68

Fortinet Inc.
 Request Parameter 1367
Request Headers 1367
Sample Request 1367
Sample Response 1368
Email 1369
Get /settings/integration/email 1370
Description 1370
Request Headers 1370
Sample Request 1370
Sample Response 1371
Get /settings/integration/email/password 1372
Description 1372
Request Headers 1372
Sample Request 1372
Sample Response 1373
Post /settings/integration/email 1374
Description 1374
Request Headers 1374
Request Body Parameters 1374
Sample Request 1375
Sample Response 1375
Post /settings/integration/email/delete 1376
Description 1376
Request Headers 1376
Sample Request 1376
Sample Response 1377
Post /settings/integration/email/test 1378
Description 1378
Request Headers 1378
Request Body Parameters 1378
Sample Request 1379
Sample Response 1379
Endpoint Compliance Configuration 1380
Delete /policy/endpoint-compliance-configuration/{id} 1381
Description 1381
Request Parameter 1381
Request Headers 1381
Sample Request 1381
Sample Response 1382
Get /policy/endpoint-compliance-configuration 1383
Description 1383
Request Headers 1383
Request Body Parameters 1383

FortiNAC F 7.4.0 REST API 69

Fortinet Inc.
 Sample Request 1383
Sample Response 1384
Get /policy/endpoint-compliance-configuration/{id} 1387
Description 1387
Request Parameter 1387
Request Headers 1387
Sample Request 1387
Sample Response 1388
Get /policy/endpoint-compliance-configuration/{id}/usage 1391
Description 1391
Request Parameter 1391
Request Headers 1391
Sample Request 1391
Sample Response 1392
Get /policy/endpoint-compliance-configuration/supporting-info 1393
Description 1393
Request Headers 1393
Sample Request 1393
Sample Response 1394
Post /policy/endpoint-compliance-configuration 1395
Description 1395
Request Headers 1395
Request Body Parameters 1395
Sample Request 1395
Sample Response 1403
Post /policy/endpoint-compliance-configuration/delete 1404
Description 1404
Request Headers 1404
Request Body Parameters 1404
Sample Request 1404
Sample Response 1405
Post /policy/endpoint-compliance-configuration/{id} 1406
Description 1406
Request Parameter 1406
Request Headers 1406
Sample Request 1406
Sample Response 1414
Post /policy/endpoint-compliance-configuration/{id}/delete 1415
Description 1415
Request Parameter 1415
Request Headers 1415
Sample Request 1415
Sample Response 1416

FortiNAC F 7.4.0 REST API 70

Fortinet Inc.
 Endpoint Compliance Policy 1417
Delete /policy/endpoint-compliance/{id} 1418
Description 1418
Request Parameter 1418
Request Headers 1418
Sample Request 1418
Sample Response 1419
Get /policy/endpoint-compliance 1420
Description 1420
Request Headers 1420
Request Body Parameters 1420
Sample Request 1420
Sample Response 1421
Get /policy/endpoint-compliance/{id} 1422
Description 1422
Request Headers 1422
Sample Request 1422
Sample Response 1423
Get /policy/endpoint-compliance/supporting-info 1424
Description 1424
Request Headers 1424
Sample Request 1424
Sample Response 1425
Post /policy/endpoint-compliance 1426
Description 1426
Request Headers 1426
Sample Request 1426
Sample Response 1435
Post /policy/endpoint-compliance/delete 1436
Description 1436
Request Headers 1436
Request Body Parameters 1436
Sample Request 1436
Sample Response 1437
Post /policy/endpoint-compliance/disable 1438
Description 1438
Request Headers 1438
Request Body Parameters 1438
Sample Request 1438
Sample Response 1439
Post /policy/endpoint-compliance/enable 1440
Description 1440
Request Headers 1440

FortiNAC F 7.4.0 REST API 71

Fortinet Inc.
 Request Body Parameters 1440
Sample Request 1440
Sample Response 1441
Post /policy/endpoint-compliance/{id} 1442
Description 1442
Request Parameter 1442
Request Headers 1442
Sample Request 1442
Sample Response 1452
Post /policy/endpoint-compliance/{id}/delete 1453
Description 1453
Request Parameter 1453
Request Headers 1453
Sample Request 1453
Sample Response 1454
Post /policy/endpoint-compliance/{id}/disable 1455
Description 1455
Request Parameter 1455
Request Headers 1455
Sample Request 1455
Sample Response 1456
Post /policy/endpoint-compliance/{id}/enable 1457
Description 1457
Request Parameter 1457
Request Headers 1457
Sample Request 1457
Sample Response 1458
Post /policy/endpoint-compliance/rank/set 1459
Description 1459
Request Headers 1459
Request Body Parameters 1459
Sample Request 1459
Sample Response 1460
Post /policy/endpoint-compliance/rank/swap 1461
Description 1461
Request Headers 1461
Request Body Parameters 1461
Sample Request 1461
Sample Response 1462
Endpoint Compliance Scan 1463
Delete /policy/endpoint-compliance/scan/{id} 1464
Description 1464
Request Parameter 1464

FortiNAC F 7.4.0 REST API 72

Fortinet Inc.
 Request Headers 1464
Sample Request 1464
Sample Response 1465
Get /policy/endpoint-compliance/scan 1466
Description 1466
Request Headers 1466
Request Body Parameters 1466
Sample Request 1466
Sample Response 1467
Get /policy/endpoint-compliance/scan/available 1469
Description 1469
Request Headers 1469
Sample Request 1469
Sample Response 1470
Get /policy/endpoint-compliance/scan/count 1472
Description 1472
Request Headers 1472
Request Body Parameters 1472
Sample Request 1472
Sample Response 1473
Get /policy/endpoint-compliance/scan/count/all 1475
Description 1475
Request Headers 1475
Sample Request 1475
Sample Response 1476
Get /policy/endpoint-compliance/scan/details 1478
Description 1478
Request Headers 1478
Request Body Parameters 1478
Sample Request 1478
Sample Response 1479
Get /policy/endpoint-compliance/scan/{id} 1481
Description 1481
Request Parameter 1481
Request Headers 1481
Sample Request 1481
Sample Response 1482
Get /policy/endpoint-compliance/scan/{id}/usage 1484
Description 1484
Request Parameter 1484
Request Headers 1484
Sample Request 1484
Sample Response 1485

FortiNAC F 7.4.0 REST API 73

Fortinet Inc.
 Get /policy/endpoint-compliance/scan/product 1486
Description 1486
Request Headers 1486
Request Body Parameters 1486
Sample Request 1486
Sample Response 1487
Post /policy/endpoint-compliance/scan/{id}/details 1488
Description 1488
Request Parameter 1488
Request Headers 1488
Sample Request 1488
Sample Response 1490
Post /policy/endpoint-compliance/scan/remove-policy-types 1491
Description 1491
Request Headers 1491
Request Body Parameters 1491
Sample Request 1491
Sample Response 1492
Post /policy/endpoint-compliance/scan 1493
Description 1493
Request Headers 1493
Sample Request 1493
Sample Response 1495
Post /policy/endpoint-compliance/scan/copy 1496
Description 1496
Request Headers 1496
Request Body Parameters 1496
Sample Request 1496
Sample Response 1497
Post /policy/endpoint-compliance/scan/delete 1498
Description 1498
Request Headers 1498
Request Body Parameters 1498
Sample Request 1498
Sample Response 1499
Post /policy/endpoint-compliance/scan/details 1500
Description 1500
Request Headers 1500
Request Body Parameters 1500
Sample Request 1500
Sample Response 1502
Post /policy/endpoint-compliance/scan/{id} 1503
Description 1503

FortiNAC F 7.4.0 REST API 74

Fortinet Inc.
 Request Parameter 1503
Request Headers 1503
Sample Request 1503
Sample Response 1505
Post /policy/endpoint-compliance/scan/{id}/delete 1506
Description 1506
Request Headers 1506
Request Body Parameters 1506
Sample Request 1506
Sample Response 1507
Event 1508
Delete /logging/event/{id} 1509
Description 1509
Request Parameter 1509
Request Headers 1509
Sample Request 1509
Sample Response 1510
Get /logging/event 1511
Description 1511
Request Headers 1511
Request Body Parameters 1511
Sample Request 1511
Sample Response 1512
Get /logging/event/archive 1513
Description 1513
Request Headers 1513
Sample Request 1513
Sample Response 1514
Get /logging/event/archive/import/status 1515
Description 1515
Request Headers 1515
Sample Request 1515
Sample Response 1516
Get /logging/event/count 1517
Description 1517
Request Headers 1517
Request Body Parameters 1517
Sample Request 1517
Sample Response 1518
Get /logging/event/count/all 1519
Description 1519
Request Headers 1519
Sample Request 1519

FortiNAC F 7.4.0 REST API 75

Fortinet Inc.
 Sample Response 1520
Get /logging/event/{id} 1521
Description 1521
Request Parameter 1521
Request Headers 1521
Sample Request 1521
Sample Response 1522
Get /logging/event/{id}/usage 1523
Description 1523
Request Parameter 1523
Request Headers 1523
Sample Request 1523
Sample Response 1524
Get /logging/event/monitor/{id} 1525
Description 1525
Request Parameter 1525
Request Headers 1525
Sample Request 1525
Sample Response 1526
Get /logging/event/supporting-info 1527
Description 1527
Request Headers 1527
Sample Request 1527
Sample Response 1528
Post /logging/event 1529
Description 1529
Request Headers 1529
Sample Request 1529
Sample Response 1530
Post /logging/event/archive/import 1531
Description 1531
Request Headers 1531
Request Body Parameters 1531
Sample Request 1531
Sample Response 1532
Post /logging/event/delete 1533
Description 1533
Request Headers 1533
Request Body Parameters 1533
Sample Request 1533
Sample Response 1534
Post /logging/event/{id} 1535
Description 1535

FortiNAC F 7.4.0 REST API 76

Fortinet Inc.
 Request Parameter 1535
Request Headers 1535
Sample Request 1535
Sample Response 1536
Post /logging/event/{id}/delete 1537
Description 1537
Request Parameter 1537
Request Headers 1537
Sample Request 1537
Sample Response 1538
Post /logging/event/monitor/start 1539
Description 1539
Request Headers 1539
Sample Request 1539
Sample Response 1540
Post /logging/event/monitor/{id}/stop 1541
Description 1541
Request Parameter 1541
Request Headers 1541
Sample Request 1541
Sample Response 1542
Post /logging/event/note 1543
Description 1543
Request Headers 1543
Request Body Parameters 1543
Sample Request 1543
Sample Response 1544
Event To Alarm Mapping 1545
Delete /logging/event-alarm-mapping/{id} 1546
Description 1546
Request Parameters 1546
Request Headers 1546
Sample Request 1546
Sample Response 1547
Get /logging/event-alarm-mapping 1548
Description 1548
Request Headers 1548
Request Body Parameters 1548
Sample Request 1548
Sample Response 1549
Get /logging/event-alarm-mapping/count/all 1552
Description 1552
Request Headers 1552

FortiNAC F 7.4.0 REST API 77

Fortinet Inc.
 Sample Request 1552
Sample Response 1553
Get /logging/event-alarm-mapping/count 1556
Description 1556
Request Headers 1556
Request Body Parameters 1556
Sample Request 1556
Sample Response 1557
Get /logging/event-alarm-mapping/{id} 1560
Description 1560
Request Parameters 1560
Request Headers 1560
Sample Request 1560
Sample Response 1561
Get /logging/event-alarm-mapping/{id}/usage 1564
Description 1564
Request Parameters 1564
Request Headers 1564
Sample Request 1564
Sample Response 1565
Get /logging/event-alarm-mapping/supporting-info 1566
Description 1566
Request Headers 1566
Sample Request 1566
Sample Response 1567
Post /logging/event-alarm-mapping 1568
Description 1568
Request Headers 1568
Sample Request 1568
Sample Response 1570
Post /logging/event-alarm-mapping/delete 1571
Description 1571
Request Headers 1571
Request Body Parameters 1571
Sample Request 1571
Sample Response 1572
Post /logging/event-alarm-mapping/disable 1573
Description 1573
Request Headers 1573
Request Body Parameters 1573
Sample Request 1573
Sample Response 1574

FortiNAC F 7.4.0 REST API 78

Fortinet Inc.
 Post /logging/event-alarm-mapping/enable 1575
Description 1575
Request Headers 1575
Request Body Parameters 1575
Sample Request 1575
Sample Response 1576
Post /logging/event-alarm-mapping/{id} 1577
Description 1577
Request Parameters 1577
Request Headers 1577
Sample Request 1577
Sample Response 1579
Post /logging/event-alarm-mapping/{id}/delete 1580
Description 1580
Request Parameters 1580
Request Headers 1580
Sample Request 1580
Sample Response 1581
Post /logging/event-alarm-mapping/modify 1582
Description 1582
Request Headers 1582
Request Body Parameters 1582
Sample Request 1582
Sample Response 1583
Event Types 1584
Get /logging/event-types 1585
Description 1585
Request Headers 1585
Request Body Parameters 1585
Sample Request 1585
Sample Response 1586
Get /logging/event-types/count 1587
Description 1587
Request Headers 1587
Request Body Parameters 1587
Sample Request 1587
Sample Response 1588
Get /logging/event-types/count/all 1589
Description 1589
Request Headers 1589
Sample Request 1589
Sample Response 1590

FortiNAC F 7.4.0 REST API 79

Fortinet Inc.
 Get /logging/event-types/count/{id} 1591
Description 1591
Request Parameter 1591
Request Headers 1591
Sample Request 1591
Sample Response 1592
Get /logging/event-types/thresholds 1593
Description 1593
Request Headers 1593
Sample Request 1593
Sample Response 1594
Post /logging/event-types/group 1595
Description 1595
Request Headers 1595
Request Body Parameters 1595
Sample Request 1595
Sample Response 1596
Post /logging/event-types/logging-strategy 1597
Description 1597
Request Headers 1597
Request Body Parameters 1597
Sample Request 1597
Sample Response 1598
Post /logging/event-types/thresholds 1599
Description 1599
Request Headers 1599
Sample Request 1599
Sample Response 1600
Group 1601
Delete /system/group/{id} 1602
Description 1602
Request Parameter 1602
Request Headers 1602
Sample Request 1602
Sample Response 1603
Get /system/group 1604
Description 1604
Request Headers 1604
Request Body Parameters 1604
Sample Request 1604
Sample Response 1605
Get /system/group/count 1606
Description 1606

FortiNAC F 7.4.0 REST API 80

Fortinet Inc.
 Request Headers 1606
Request Body Parameters 1606
Sample Request 1606
Sample Response 1607
Get /system/group/count/all 1608
Description 1608
Request Headers 1608
Sample Request 1608
Sample Response 1609
Get /system/group/{id} 1610
Description 1610
Request Parameter 1610
Request Headers 1610
Sample Request 1610
Sample Response 1611
Get /system/group/{id}/descendants 1612
Description 1612
Request Parameter 1612
Request Headers 1612
Request Body Parameters 1612
Sample Request 1612
Sample Response 1613
Get /system/group/{id}/member-ids 1614
Description 1614
Request Parameter 1614
Request Headers 1614
Sample Request 1614
Sample Response 1615
Get /system/group/{id}/members 1616
Description 1616
Request Parameter 1616
Request Headers 1616
Request Body Parameters 1616
Sample Request 1616
Sample Response 1617
Get /system/group/{id}/usage 1618
Description 1618
Request Parameter 1618
Request Headers 1618
Sample Request 1618
Sample Response 1619
Post /system/group/add-members 1620
Description 1620

FortiNAC F 7.4.0 REST API 81

Fortinet Inc.
 Request Headers 1620
Request Body Parameters 1620
Sample Request 1620
Sample Response 1621
Post /system/group/add-to-parents 1622
Description 1622
Request Headers 1622
Request Body Parameters 1622
Sample Request 1622
Sample Response 1623
Post /system/group/aging 1624
Description 1624
Request Headers 1624
Request Body Parameters 1624
Sample Request 1624
Sample Response 1625
Post /system/group/copy 1626
Description 1626
Request Headers 1626
Request Body Parameters 1626
Sample Request 1626
Sample Response 1627
Post /system/group/delete 1628
Description 1628
Request Headers 1628
Request Body Parameters 1628
Sample Request 1628
Sample Response 1629
Post /system/group/{groupID}/manages 1630
Description 1630
Request Parameter 1630
Request Headers 1630
Sample Request 1630
Sample Response 1631
Post /system/group/{groupType} 1632
Description 1632
Request Parameter 1632
Request Headers 1632
Sample Request 1632
Sample Response 1633
Post /system/group/{groupType}/{id} 1634
Description 1634
Request Parameter 1634

FortiNAC F 7.4.0 REST API 82

Fortinet Inc.
 Request Headers 1634
Sample Request 1634
Sample Response 1635
Post /system/group/{id}/delete 1636
Description 1636
Request Parameter 1636
Request Headers 1636
Sample Request 1636
Sample Response 1637
Post /system/group/membership 1638
Description 1638
Request Headers 1638
Request Body Parameters 1638
Sample Request 1638
Sample Response 1639
Post /system/group/remove-from-parent 1640
Description 1640
Request Headers 1640
Request Body Parameters 1640
Sample Request 1640
Sample Response 1641
Post /system/group/remove-members 1642
Description 1642
Request Headers 1642
Request Body Parameters 1642
Sample Request 1642
Sample Response 1643
GuestTemplate 1644
Delete /user/guest-template/{id} 1645
Description 1645
Request Parameter 1645
Request Headers 1645
Sample Request 1645
Sample Response 1646
Get /user/guest-template 1647
Description 1647
Request Headers 1647
Request Body Parameters 1647
Sample Request 1647
Sample Response 1648
Get /user/guest-template/count 1651
Description 1651
Request Headers 1651

FortiNAC F 7.4.0 REST API 83

Fortinet Inc.
 Request Body Parameters 1651
Sample Request 1651
Sample Response 1652
Get /user/guest-template/count/all 1655
Description 1655
Request Headers 1655
Sample Request 1655
Sample Response 1656
Get /user/guest-template/{id} 1659
Description 1659
Request Parameter 1659
Request Headers 1659
Sample Request 1659
Sample Response 1660
Get /user/guest-template/{id}/usage 1663
Description 1663
Request Parameter 1663
Request Headers 1663
Sample Request 1663
Sample Response 1664
Get /user/guest-template/resolve-ip 1665
Description 1665
Request Body Parameters 1665
Request Headers 1665
Sample Request 1665
Sample Response 1666
Post /user/guest-template 1667
Description 1667
Request Headers 1667
Sample Request 1667
Sample Response 1669
Post /user/guest-template/delete 1670
Description 1670
Request Headers 1670
Request Body Parameters 1670
Sample Request 1670
Sample Response 1671
Post /user/guest-template/{id} 1672
Description 1672
Request Parameter 1672
Request Headers 1672
Sample Request 1672
Sample Response 1674

FortiNAC F 7.4.0 REST API 84

Fortinet Inc.
 Post /user/guest-template/{id}/delete 1675
Description 1675
Request Parameter 1675
Request Headers 1675
Sample Request 1675
Sample Response 1676
High Availability 1677
Get /system/high-availability 1678
Description 1678
Request Headers 1678
Sample Request 1678
Sample Response 1679
Get /system/high-availability/password/{pwkey} 1680
Description 1680
Request Parameter 1680
Request Headers 1680
Sample Request 1680
Sample Response 1681
Post /system/high-availability 1682
Description 1682
Request Headers 1682
Sample Request 1682
Sample Response 1683
Host Record 1684
Get /host 1685
Description 1685
Request Headers 1685
Request Body Parameters 1685
Sample Request 1685
Sample Response 1686
Get /host/{id}/health-history 1689
Description 1689
Request Parameter 1689
Request Headers 1689
Sample Request 1689
Sample Response 1690
Get /host/multifilter 1691
Description 1691
Request Headers 1691
Request Body Parameters 1691
Sample Request 1691
Sample Response 1693

FortiNAC F 7.4.0 REST API 85

Fortinet Inc.
 Get /host/multifilter/users 1696
Description 1696
Request Headers 1696
Request Body Parameters 1696
Sample Request 1696
Sample Response 1698
Get /host/ncm-pods 1701
Description 1701
Request Headers 1701
Sample Request 1701
Sample Response 1702
Get /host/search 1705
Description 1705
Request Headers 1705
Request Body Parameters 1705
Sample Request 1705
Sample Response 1706
Post /host 1709
Description 1709
Request Headers 1709
Sample Request 1709
Sample Response 1733
Post /host/disable-by-ip 1734
Description 1734
Request Headers 1734
Request Body Parameters 1734
Sample Request 1734
Sample Response 1735
Post /host/disable-by-mac 1736
Description 1736
Request Headers 1736
Request Body Parameters 1736
Sample Request 1736
Sample Response 1737
Post /host/enable-by-ip 1738
Description 1738
Request Headers 1738
Sample Request 1738
Request Body Parameters 1738
Sample Response 1739
Post /host/enable-by-mac 1740
Description 1740
Request Headers 1740

FortiNAC F 7.4.0 REST API 86

Fortinet Inc.
 Request Body Parameters 1740
Sample Request 1740
Sample Response 1741
Post /host/register-as-device 1742
Description 1742
Request Headers 1742
Request Body Parameters 1742
Sample Request 1742
Sample Response 1743
Post /host/set-logged-on-user 1744
Description 1744
Request Headers 1744
Request Body Parameters 1744
Sample Request 1744
Sample Response 1745
Post /host/with-adapters 1746
Description 1746
Request Headers 1746
Sample Request 1746
Sample Response 1770
LDAP 1771
Delete /settings/integration/ldap/{id} 1772
Description 1772
Request Parameter 1772
Request Headers 1772
Sample Request 1772
Sample Response 1773
Get /settings/integration/ldap 1774
Description 1774
Request Headers 1774
Request Body Parameters 1774
Sample Request 1774
Sample Response 1775
Get /settings/integration/ldap/count 1778
Description 1778
Request Headers 1778
Sample Request 1778
Sample Response 1779
Get /settings/integration/ldap/count/all 1782
Description 1782
Request Headers 1782
Sample Request 1782
Sample Response 1783

FortiNAC F 7.4.0 REST API 87

Fortinet Inc.
 Get /settings/integration/ldap/{id} 1786
Description 1786
Request Parameter 1786
Request Headers 1786
Sample Request 1786
Sample Response 1787
Get /settings/integration/ldap/{id}/usage 1790
Description 1790
Request Headers 1790
Sample Request 1790
Sample Response 1791
Post /settings/integration/ldap 1792
Description 1792
Request Headers 1792
Sample Request 1792
Sample Response 1793
Post /settings/integration/ldap/delete 1794
Description 1794
Request Headers 1794
Request Body Parameters 1794
Sample Request 1794
Sample Response 1795
Post /settings/integration/ldap/{id} 1796
Description 1796
Request Parameter 1796
Request Headers 1796
Sample Request 1796
Sample Response 1797
Post /settings/integration/ldap/{id}/delete 1798
Description 1798
Request Parameter 1798
Request Headers 1798
Sample Request 1798
Sample Response 1799
License Management 1800
Get /system/license-management 1801
Description 1801
Request Headers 1801
Request Body Parameters 1801
Sample Request 1801
Sample Response 1802

FortiNAC F 7.4.0 REST API 88

Fortinet Inc.
 Log Receiver 1803
Get /settings/integration/log-receiver 1804
Description 1804
Request Headers 1804
Sample Request 1804
Sample Response 1805
Post /settings/integration/log-receiver 1806
Description 1806
Request Headers 1806
Sample Request 1806
Sample Response 1807
Post /settings/integration/log-receiver/delete 1808
Description 1808
Request Headers 1808
Request Body Parameters 1808
Sample Request 1808
Sample Response 1809
Logical Network 1810
Get /policy/logical-network 1811
Description 1811
Request Headers 1811
Request Body Parameters 1811
Sample Request 1811
Sample Response 1812
Get /policy/logical-network/{id} 1813
Description 1813
Request Parameter 1813
Request Headers 1813
Sample Request 1813
Sample Response 1814
Get /policy/logical-network/{id}/usage 1815
Description 1815
Request Parameter 1815
Request Headers 1815
Sample Request 1815
Sample Response 1816
Post /policy/logical-network 1817
Description 1817
Request Headers 1817
Sample Request 1817
Sample Response 1818
Post /policy/logical-network/add-predefined-network-access 1819
Description 1819

FortiNAC F 7.4.0 REST API 89

Fortinet Inc.
 Request Headers 1819
Sample Request 1819
Sample Response 1820
Post /policy/logical-network/delete 1821
Description 1821
Request Headers 1821
Request Body Parameters 1821
Sample Request 1821
Sample Response 1822
Post /policy/logical-network/{id} 1823
Description 1823
Request Parameter 1823
Request Headers 1823
Sample Request 1823
Sample Response 1824
Post /policy/logical-network/{id}/delete 1825
Description 1825
Request Parameter 1825
Request Headers 1825
Sample Request 1825
Sample Response 1826
Delete /policy/logical-network/{id} 1827
Description 1827
Request Parameter 1827
Request Headers 1827
Sample Request 1827
Sample Response 1828
MDM 1829
Delete /settings/integration/mdm/{id} 1830
Description 1830
Request Parameter 1830
Request Headers 1830
Sample Request 1830
Sample Response 1831
Get /settings/integration/mdm 1832
Description 1832
Request Headers 1832
Request Body Parameters 1832
Sample Request 1832
Sample Response 1833
Get /settings/integration/mdm/{id} 1834
Description 1834
Request Parameter 1834

FortiNAC F 7.4.0 REST API 90

Fortinet Inc.
 Request Headers 1834
Sample Request 1834
Sample Response 1835
Get /settings/integration/mdm/{id}/password 1836
Description 1836
Request Parameter 1836
Request Headers 1836
Sample Request 1836
Sample Response 1837
Get /settings/integration/mdm/{id}/usage 1838
Description 1838
Request Parameter 1838
Request Headers 1838
Sample Request 1838
Sample Response 1839
Post /settings/integration/mdm 1840
Description 1840
Request Headers 1840
Sample Request 1840
Sample Response 1841
Post /settings/integration/mdm/delete 1842
Description 1842
Request Headers 1842
Request Body Parameters 1842
Sample Request 1842
Sample Response 1843
Post /settings/integration/mdm/{id} 1844
Description 1844
Request Parameter 1844
Request Headers 1844
Sample Request 1844
Sample Response 1845
Post /settings/integration/mdm/authenticate 1846
Description 1846
Request Body Parameters 1846
Request Headers 1846
Sample Request 1847
Sample Response 1847
Post /settings/integration/mdm/{id}/delete 1848
Description 1848
Request Parameter 1848
Request Headers 1848
Sample Request 1848

FortiNAC F 7.4.0 REST API 91

Fortinet Inc.
 Sample Response 1849
Post /settings/integration/mdm/{id}/poll 1850
Description 1850
Request Parameter 1850
Request Headers 1850
Sample Request 1850
Sample Response 1851
Post /settings/integration/mdm/{id}/test 1852
Description 1852
Request Parameter 1852
Request Headers 1852
Sample Request 1852
Sample Response 1853
Proxy 1854
Get /settings/integration/proxy 1855
Description 1855
Request Headers 1855
Sample Request 1855
Sample Response 1856
Post /settings/integration/proxy 1857
Description 1857
Request Headers 1857
Sample Request 1858
Sample Response 1858
Role 1859
Delete /policy/role/{id} 1860
Description 1860
Request Parameter 1860
Request Headers 1860
Sample Request 1860
Sample Response 1861
Get /policy/role 1862
Description 1862
Request Headers 1862
Request Body Parameters 1862
Sample Request 1862
Sample Response 1863
Get /policy/role/{id} 1864
Description 1864
Request Parameter 1864
Request Headers 1864
Sample Request 1864
Sample Response 1865

FortiNAC F 7.4.0 REST API 92

Fortinet Inc.
 Get /policy/role/{id}/usage 1866
Description 1866
Request Parameter 1866
Request Headers 1866
Sample Request 1866
Sample Response 1867
Get /policy/role/simple 1868
Description 1868
Request Headers 1868
Sample Request 1868
Sample Response 1869
Get /policy/role/supporting-info 1870
Description 1870
Request Headers 1870
Sample Request 1870
Sample Response 1871
Post /policy/role 1872
Description 1872
Request Headers 1872
Sample Request 1872
Sample Response 1873
Post /policy/role/delete 1874
Description 1874
Request Headers 1874
Request Body Parameters 1874
Sample Request 1874
Sample Response 1875
Post /policy/role/{id} 1876
Description 1876
Request Parameter 1876
Request Headers 1876
Sample Request 1876
Sample Response 1877
Post /policy/role/{id}/delete 1878
Description 1878
Request Parameter 1878
Request Headers 1878
Sample Request 1878
Sample Response 1879
Post /policy/role/rank/set 1880
Description 1880
Request Headers 1880
Request Body Parameters 1880

FortiNAC F 7.4.0 REST API 93

Fortinet Inc.
 Sample Request 1880
Sample Response 1881
Post /policy/role/rank/swap 1882
Description 1882
Request Headers 1882
Request Body Parameters 1882
Sample Request 1882
Sample Response 1883
Post /settings/integration/vendor-oui/{id}/delete 1884
Description 1884
Request Parameter 1884
Request Headers 1884
Sample Request 1884
Sample Response 1885
Services 1886
Get /system/ntp 1887
Description 1887
Request Headers 1887
Request Body Parameters 1887
Sample Request 1887
Sample Response 1888
Get /system/ntp/servers 1889
Description 1889
Request Headers 1889
Sample Request 1889
Sample Response 1890
Post /system/ntp 1891
Description 1891
Request Headers 1891
Request Body Parameters 1891
Sample Request 1891
Sample Response 1892
SNMP 1893
Get /settings/integration/SNMP 1894
Description 1894
Request Headers 1894
Sample Request 1894
Sample Response 1895
Get /settings/integration/SNMP/auth-pssword 1896
Description 1896
Request Headers 1896
Sample Request 1896
Sample Response 1897

FortiNAC F 7.4.0 REST API 94

Fortinet Inc.
 Get /settings/integration/SNMP/priv-pssword 1898
Description 1898
Request Headers 1898
Sample Request 1898
Sample Response 1899
Post /settings/integration/SNMP 1900
Description 1900
Request Headers 1900
Request Body Parameters 1900
Sample Response 1902
System 1903
Get /system/local-properties/cluster 1904
Description 1904
Request Headers 1904
Request Body Parameters 1904
Sample Response 1905
Get /system/local-properties/config-status 1906
Request Headers 1906
Sample Request 1906
Sample Response 1907
Get /system/local-properties/globaloption/{param} 1908
Description 1908
Request Parameter 1908
Request Headers 1908
Sample Request 1908
Sample Response 1909
Get /system/local-properties/hardware 1910
Description 1910
Request Headers 1910
Sample Request 1910
Sample Response 1911
Get /system/local-properties/hardware/performance 1914
Description 1914
Request Headers 1914
Sample Request 1914
Sample Response 1915
Get /system/local-properties/license 1916
Description 1916
Request Headers 1916
Sample Request 1916
Sample Response 1917
Get /system/local-properties/license/concurrent 1918
Description 1918

FortiNAC F 7.4.0 REST API 95

Fortinet Inc.
 Request Headers 1918
Request Body Parameters 1918
Sample Request 1918
Sample Response 1919
Get /system/local-properties/software-details 1920
Description 1920
Request Headers 1920
Sample Request 1920
Sample Response 1921
Post /system/local-properties/cluster/application/primary/restart 1922
Description 1922
Request Headers 1922
Sample Request 1922
Sample Response 1923
Post /system/local-properties/cluster/control/primary/restart 1924
Description 1924
Request Headers 1924
Sample Request 1924
Sample Response 1925
Post /system/local-properties/hardware/thresholds 1926
Description 1926
Request Parameter 1926
Request Headers 1926
Request Body Parameters 1926
Sample Request 1927
Sample Response 1927
Post /system/local-properties/license/apply 1928
Description 1928
Request Headers 1928
Request Body Parameters 1928
Sample Request 1928
Sample Response 1929
Post /system/local-properties/passwords/change 1930
Description 1930
Request Headers 1930
Sample Request 1930
Sample Response 1931
Post /system/local-properties/system/initialize 1932
Description 1932
Request Headers 1932
Sample Request 1932
Sample Response 1933

FortiNAC F 7.4.0 REST API 96

Fortinet Inc.
 Vendor OUI 1934
Delete /settings/integration/vendor-oui/{id} 1935
Description 1935
Request Parameter 1935
Request Headers 1935
Sample Request 1935
Sample Response 1936
Get /settings/integration/vendor-oui 1937
Description 1937
Request Headers 1937
Request Body Parameters 1937
Sample Request 1937
Sample Response 1938
Get /settings/integration/vendor-oui/count 1939
Description 1939
Request Headers 1939
Request Body Parameters 1939
Sample Request 1939
Sample Response 1940
Get /settings/integration/vendor-oui/count/all 1941
Description 1941
Request Headers 1941
Sample Request 1941
Sample Response 1942
Get /settings/integration/vendor-oui/count/{id} 1943
Description 1943
Request Parameter 1943
Request Headers 1943
Sample Request 1943
Sample Response 1944
Get /settings/integration/vendor-oui/supporting-info 1945
Description 1945
Request Headers 1945
Sample Request 1945
Sample Response 1946
Post /settings/integration/vendor-oui 1947
Description 1947
Request Headers 1947
Sample Request 1947
Sample Response 1948
Post /settings/integration/vendor-oui/delete 1949
Description 1949
Request Headers 1949

FortiNAC F 7.4.0 REST API 97

Fortinet Inc.
 Request Body Parameters 1949
Sample Request 1949
Sample Response 1950
Post /settings/integration/vendor-oui/{id}/delete 1951
Description 1951
Request Parameter 1951
Request Headers 1951
Sample Request 1951
Sample Response 1952
Post /settings/integration/vendor-oui/{id} 1953
Description 1953
Request Parameter 1953
Request Headers 1953
Sample Request 1953
Sample Response 1954
Network Address 1955
Get /settings/device/network-address 1956
Description 1956
Request Headers 1956
Request Body Parameters 1956
Sample Request 1956
Sample Response 1957
Get /settings/device/network-address/{id} 1958
Description 1958
Request Parameter 1958
Request Headers 1958
Sample Request 1958
Sample Response 1959
Get /settings/device/network-address/{id}/usage 1960
Description 1960
Request Parameter 1960
Request Headers 1960
Sample Request 1960
Sample Response 1961
Post /settings/device/network-address/delete 1962
Description 1962
Request Headers 1962
Request Body Parameters 1962
Sample Request 1962
Sample Response 1963
Post /settings/device/network-address/{id} 1964
Description 1964
Request Parameter 1964

FortiNAC F 7.4.0 REST API 98

Fortinet Inc.
 Request Headers 1964
Sample Request 1964
Sample Response 1965
Post /settings/device/network-address/{id}/delete 1966
Description 1966
Request Parameter 1966
Request Headers 1966
Sample Request 1966
Sample Response 1967
Post /settings/device/network-address 1968
Description 1968
Request Headers 1968
Sample Request 1968
Sample Response 1969
Delete /settings/device/network-address/{id} 1970
Description 1970
Request Parameter 1970
Request Headers 1970
Sample Request 1970
Sample Response 1971
Network Address Group 1972
Get /settings/device/network-address-group/{id} 1973
Description 1973
Request Parameter 1973
Request Headers 1973
Sample Request 1973
Sample Response 1974
Get /settings/device/network-address-group 1975
Description 1975
Request Headers 1975
Request Body Parameters 1975
Sample Request 1975
Sample Response 1976
Get /settings/device/network-address-group/{id}/usage 1977
Description 1977
Request Parameter 1977
Request Headers 1977
Sample Request 1977
Sample Response 1978
Post /settings/device/network-address-group/delete 1979
Description 1979
Request Headers 1979
Request Body Parameters 1979

FortiNAC F 7.4.0 REST API 99

Fortinet Inc.
 Sample Request 1979
Sample Response 1980
Post /settings/device/network-address-group/{id}/delete 1981
Description 1981
Request Parameter 1981
Request Headers 1981
Sample Request 1981
Sample Response 1982
Post /settings/device/network-address-group/{id} 1983
Description 1983
Request Parameter 1983
Request Headers 1983
Sample Request 1983
Sample Response 1984
Post /settings/device/network-address-group 1985
Description 1985
Request Headers 1985
Sample Request 1985
Sample Response 1986
Delete /settings/device/network-address-group/{id} 1987
Description 1987
Request Parameter 1987
Request Headers 1987
Sample Request 1987
Sample Response 1988
Network Device 1989
Get /device/count 1990
Description 1990
Request Headers 1990
Request Body Parameters 1990
Sample Request 1990
Sample Response 1991
Get /device/{id} 1994
Description 1994
Parameter 1994
Request Headers 1994
Sample Request 1994
Sample Response 1995
Get /device/monitor/{id} 1998
Description 1998
Request Parameter 1998
Request Headers 1998
Sample Request 1998

FortiNAC F 7.4.0 REST API 100

Fortinet Inc.
 Sample Response 1999
Get /device/count/all 2002
Description 2002
Request Headers 2002
Sample Request 2002
Sample Response 2003
Get /device 2006
Description 2006
Request Headers 2006
Request Body Parameters 2006
Sample Request 2006
Sample Response 2007
Get /device/{id}/usage 2010
Description 2010
Request Parameter 2010
Request Headers 2010
Sample Request 2010
Sample Response 2011
Get /device/polling/l3 2012
Description 2012
Request Headers 2012
Request Body Parameters 2012
Sample Request 2012
Sample Response 2013
Get /device/certificate/{id} 2014
Description 2014
Request Parameter 2014
Request Headers 2014
Sample Request 2014
Sample Response 2015
Get /device/move 2016
Description 2016
Request Headers 2016
Request Body Parameters 2016
Sample Request 2016
Sample Response 2017
Get /device/properties 2018
Description 2018
Request Headers 2018
Sample Request 2018
Sample Response 2019
Post /device/delete 2020
Description 2020

FortiNAC F 7.4.0 REST API 101

Fortinet Inc.
 Request Headers 2020
Request Body Parameters 2020
Sample Request 2020
Sample Response 2021
Post /device/certificate/{id}/import 2022
Description 2022
Request Parameter 2022
Request Headers 2022
Sample Request 2022
Sample Response 2023
Post /device/certificate/poll/l2 2024
Description 2024
Request Parameter 2024
Request Headers 2024
Request Body Parameters 2024
Sample Request 2024
Sample Response 2025
Post /device/certificate/poll/l3 2026
Description 2026
Request Parameter 2026
Request Headers 2026
Request Body Parameters 2026
Sample Request 2026
Sample Response 2027
Post /device/remove-attribute/{id} 2028
Description 2028
Request Parameter 2028
Request Headers 2028
Request Body Parameters 2028
Sample Request 2028
Sample Response 2029
Post /device/resync-interfaces 2030
Description 2030
Request Headers 2030
Request Body Parameters 2030
Sample Request 2030
Sample Response 2031
Post /device/update-attribute/{id} 2032
Description 2032
Request Parameter 2032
Request Headers 2032
Request Body Parameters 2032
Sample Request 2032

FortiNAC F 7.4.0 REST API 102

Fortinet Inc.
 Sample Response 2033
Post /device/virtualized-devices/{id} 2034
Description 2034
Request Parameter 2034
Request Headers 2034
Sample Request 2034
Sample Response 2035
Post /device/{id}/delete 2036
Description 2036
Request Parameter 2036
Request Headers 2036
Sample Request 2036
Sample Response 2037
Post /device/monitor/{id}/stop 2038
Description 2038
Request Parameter 2038
Request Headers 2038
Sample Request 2038
Sample Response 2039
Post /device/monitor/start 2040
Description 2040
Request Headers 2040
Sample Request 2040
Sample Response 2041
Post /device/pingable/{id} 2044
Description 2044
Parameter 2044
Request Headers 2044
Sample Request 2044
Sample Response 2045
Post /device/pingable 2046
Description 2046
Request Headers 2046
Sample Request 2046
Sample Response 2047
Post /device/properties 2048
Description 2048
Request Headers 2048
Request Body Parameters 2048
Sample Request 2049
Sample Response 2051
Post /device/snmp 2052
Description 2052

FortiNAC F 7.4.0 REST API 103

Fortinet Inc.
 Request Headers 2052
Sample Request 2052
Sample Response 2053
Post /device/snmp/{id} 2054
Description 2054
Request Headers 2054
Sample Request 2054
Sample Response 2056
Delete /device/{id} 2057
Description 2057
Parameter 2057
Request Headers 2057
Sample Request 2057
Sample Response 2058
OS Update 2059
Get /settings/udpates/os-updates 2060
Description 2060
Request Headers 2060
Sample Request 2060
Sample Response 2061
Get /settings/udpates/os-updates/logs 2062
Description 2062
Request Headers 2062
Sample Request 2062
Sample Response 2063
Get /settings/udpates/os-updates/update-data 2064
Description 2064
Request Headers 2064
Sample Request 2064
Sample Response 2065
PA Packet Transport Config 2066
Get /settings/agent/pa-packet-transport-config 2067
Description 2067
Request Headers 2067
Request Body Parameters 2067
Sample Request 2067
Sample Response 2068
Get /settings/agent/pa-packet-transport-config/{id}/usage 2069
Description 2069
Request Parameter 2069
Request Headers 2069
Sample Request 2069
Sample Response 2070

FortiNAC F 7.4.0 REST API 104

Fortinet Inc.
 Get /settings/agent/pa-packet-transport-config/performance 2071
Description 2071
Request Headers 2071
Sample Request 2071
Sample Response 2072
Get /settings/agent/pa-packet-transport-config/{id} 2073
Description 2073
Request Parameter 2073
Request Headers 2073
Sample Request 2073
Sample Response 2074
Post /settings/agent/pa-packet-transport-config 2075
Description 2075
Request Headers 2075
Sample Request 2075
Sample Response 2076
Post /settings/agent/pa-packet-transport-config/delete 2077
Description 2077
Request Headers 2077
Request Body Parameters 2077
Sample Request 2077
Sample Response 2078
Post /settings/agent/pa-packet-transport-config/{id} 2079
Description 2079
Request Parameter 2079
Request Headers 2079
Sample Request 2079
Sample Response 2080
Post /settings/agent/pa-packet-transport-config/{id}/delete 2081
Description 2081
Request Parameter 2081
Request Headers 2081
Sample Request 2081
Sample Response 2082
Post /settings/agent/pa-packet-transport-config/deploy 2083
Description 2083
Request Headers 2083
Sample Request 2083
Sample Response 2084
Delete /settings/agent/pa-packet-transport-config/{id} 2085
Description 2085
Request Parameter 2085
Request Headers 2085

FortiNAC F 7.4.0 REST API 105

Fortinet Inc.
 Sample Request 2085
Sample Response 2086
Patch Management 2087
Get /settings/integration/patch-management 2088
Description 2088
Request Headers 2088
Sample Request 2088
Sample Response 2089
Post /settings/integration/patch-management/big-fix 2090
Description 2090
Request Headers 2090
Sample Request 2090
Sample Response 2091
Post /settings/integration/patch-management/patch-link/{id} 2092
Description 2092
Request Headers 2092
Sample Request 2092
Sample Response 2093
Post /settings/integration/patch-management/properties/big-fix/{id} 2094
Description 2094
Request Parameter 2094
Request Headers 2094
Request Body parameter 2094
Sample Response 2095
Post /settings/integration/patch-management/properties/patch-link/{id} 2096
Description 2096
Request Headers 2096
Request Body Parameters 2096
Sample Request 2096
Sample Response 2097
Post /settings/integration/patch-management/test 2098
Description 2098
Request Headers 2098
Sample Request 2098
Sample Response 2099
Post /settings/integration/patch-management/test/{id} 2100
Description 2100
Request Parameter 2100
Request Headers 2100
Sample Request 2100
Sample Response 2101

FortiNAC F 7.4.0 REST API 106

Fortinet Inc.
 Port 2102
Get /device/port 2103
Description 2103
Request Headers 2103
Request Body Parameters 2103
Sample Request 2103
Sample Response 2104
Get /device/port/by-device 2105
Description 2105
Request Headers 2105
Request Body Parameters 2105
Sample Response 2106
Get /device/port/count 2107
Description 2107
Request Headers 2107
Sample Request 2107
Sample Response 2108
Get /device/port/count/all 2109
Description 2109
Request Headers 2109
Sample Request 2109
Sample Response 2110
Get /device/port/enforcement 2111
Description 2111
Request Headers 2111
Request Body Parameters 2111
Sample Request 2111
Sample Response 2113
Get /device/port/enforcement/count 2114
Description 2114
Request Headers 2114
Sample Request 2114
Sample Response 2115
Get /device/port/feature/port-management 2116
Description 2116
Request Headers 2116
Request Body Parameters 2116
Sample Response 2117
Get /device/port/{id} 2118
Description 2118
Request Parameter 2118
Request Headers 2118
Sample Request 2118

FortiNAC F 7.4.0 REST API 107

Fortinet Inc.
 Sample Response 2119
Get /device/port/monitor/{id} 2120
Description 2120
Request Parameter 2120
Request Headers 2120
Sample Request 2120
Sample Response 2121
Get /device/port-changes 2123
Description 2123
Request Headers 2123
Request Body Parameters 2123
Sample Request 2123
Sample Response 2124
Get /device/port-changes/count 2125
Description 2125
Request Headers 2125
Sample Request 2125
Sample Response 2126
Get /device/port-changes/count/all 2127
Description 2127
Request Headers 2127
Sample Request 2127
Sample Response 2128
Get /device/port-changes/{id} 2129
Description 2129
Request Parameter 2129
Request Headers 2129
Sample Request 2129
Sample Response 2130
Post /device/port/monitor/{id}/stop 2131
Description 2131
Request Parameter 2131
Request Headers 2131
Sample Request 2131
Sample Response 2132
Post /device/port/monitor/start 2133
Description 2133
Request Headers 2133
Sample Request 2133
Sample Response 2134
Post /device/port/properties 2135
Description 2135
Request Headers 2135

FortiNAC F 7.4.0 REST API 108

Fortinet Inc.
 Sample Request 2135
Sample Response 2136
Portal Configuration 2137
Get /policy/portal-configuration 2138
Description 2138
Request Headers 2138
Request Body Parameters 2138
Sample Request 2138
Sample Response 2139
Get /policy/portal-configuration/{id} 2140
Description 2140
Request Parameter 2140
Request Headers 2140
Sample Request 2140
Sample Response 2141
Get /policy/portal-configuration/{id}/usage 2143
Description 2143
Request Parameter 2143
Request Headers 2143
Sample Request 2143
Sample Response 2144
Portal Policy 2145
Get /policy/portal 2146
Description 2146
Request Headers 2146
Request Body Parameters 2146
Sample Request 2146
Sample Response 2147
Get /policy/portal/supporting-info 2149
Description 2149
Request Headers 2149
Sample Request 2149
Sample Response 2150
Get /policy/portal/{id} 2151
Description 2151
Request Parameter 2151
Request Headers 2151
Sample Request 2151
Sample Response 2152
Post /policy/portal 2154
Description 2154
Request Headers 2154
Sample Request 2154

FortiNAC F 7.4.0 REST API 109

Fortinet Inc.
 Sample Response 2160
Post /policy/portal/delete 2161
Description 2161
Request Headers 2161
Request Body Parameters 2161
Sample Request 2161
Sample Response 2162
Post /policy/portal/disable 2163
Description 2163
Request Headers 2163
Request Body Parameters 2163
Sample Request 2163
Sample Response 2164
Post /policy/portal/enable 2165
Description 2165
Request Headers 2165
Request Body Parameters 2165
Sample Request 2165
Sample Response 2166
Post /policy/portal/{id} 2167
Description 2167
Request Parameter 2167
Request Headers 2167
Sample Request 2167
Sample Response 2173
Post /policy/portal/{id}/delete 2174
Description 2174
Request Parameter 2174
Request Headers 2174
Sample Request 2174
Sample Response 2175
Post /policy/portal/rank/set 2176
Description 2176
Request Headers 2176
Request Body Parameters 2176
Sample Request 2176
Sample Response 2177
Post /policy/portal/rank/swap 2178
Description 2178
Request Headers 2178
Request Body Parameters 2178
Sample Request 2178
Sample Response 2179

FortiNAC F 7.4.0 REST API 110

Fortinet Inc.
 Delete /policy/portal-configuration/{id} 2180
Description 2180
Request Parameter 2180
Request Headers 2180
Sample Request 2180
Sample Response 2181
Portal Settings 2182
Get /portal/settings/ssl 2183
Description 2183
Request Headers 2183
Sample Request 2183
Sample Response 2184
Post /portal/settings/ssl 2185
Description 2185
Request Headers 2185
Sample Request 2185
Sample Response 2186
Quarantine 2187
Get /settings/device/quarantine 2188
Description 2188
Request Headers 2188
Sample Request 2188
Sample Response 2189
Post /settings/device/quarantine 2190
Description 2190
Request Headers 2190
Request Body Parameters 2190
Sample Request 2190
Sample Response 2191
Post /settings/device/quarantine/mark-all-hosts-safe 2192
Description 2192
Request Headers 2192
Sample Request 2192
Sample Response 2193
Radius Attribute Group Configuration 2194
Get /radius/attrgroups 2195
Description 2195
Request Headers 2195
Request Body Parameters 2195
Sample Request 2195
Sample Response 2196

FortiNAC F 7.4.0 REST API 111

Fortinet Inc.
 Get /radius/attrgroups/modelcfg/{deviceId} 2197
Description 2197
Request Parameter 2197
Request Headers 2197
Request Body Parameters 2197
Sample Request 2197
Sample Response 2198
Get /radius/attrgroups/{attrGroupId} 2199
Description 2199
Request Parameter 2199
Request Headers 2199
Sample Request 2199
Sample Response 2200
Get /radius/attrgroups/name/{groupName} 2201
Description 2201
Request Parameter 2201
Request Headers 2201
Sample Request 2201
Sample Response 2202
Get /radius/attrgroups/{attrGroupId}/usage 2203
Description 2203
Request Parameter 2203
Request Headers 2203
Sample Request 2203
Sample Response 2204
Get /radius/attrgroups/list 2205
Description 2205
Request Headers 2205
Sample Request 2205
Sample Response 2206
Get /radius/attrgroups/responsevalues/{deviceAttrGrpId}/
{logicalNetworkAttrGrpId} 2207
Description 2207
Request Parameters 2207
Request Headers 2207
Sample Request 2207
Sample Response 2208
Post /radius/attrgroups 2209
Description 2209
Request Headers 2209
Sample Request 2209
Sample Response 2211

FortiNAC F 7.4.0 REST API 112

Fortinet Inc.
 Post /radius/attrgroups/delete 2212
Description 2212
Request Headers 2212
Request Body Parameters 2212
Sample Request 2212
Sample Response 2213
Post /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId} 2214
Description 2214
Request Parameter 2214
Request Headers 2214
Request Body Parameters 2214
Sample Request 2214
Sample Response 2215
Post /radius/attrgroups/{id} 2216
Description 2216
Request Parameter 2216
Request Headers 2216
Sample Request 2216
Sample Response 2218
Delete /radius/attrgroups/{id} 2219
Description 2219
Request Parameter 2219
Request Headers 2219
Sample Request 2219
Sample Response 2220
Delete /radius/attrgroups/modelcfg/{deviceId} 2221
Description 2221
Request Parameter 2221
Request Headers 2221
Request Body Parameters 2221
Sample Request 2221
Sample Response 2222
Radius Dictionary Configuration 2223
Get /radius/dictionary 2224
Description 2224
Request Headers 2224
Request Body Parameters 2224
Sample Request 2224
Sample Response 2225
Get /radius/dictionary/attribute/{name} 2226
Description 2226
Request Parameter 2226
Request Headers 2226

FortiNAC F 7.4.0 REST API 113

Fortinet Inc.
 Sample Request 2226
Sample Response 2227
Post /radius/dictionary 2228
Description 2228
Request Headers 2228
Sample Request 2228
Sample Response 2229
Post /radius/dictionary/delete 2230
Description 2230
Request Headers 2230
Request Body Parameters 2230
Sample Request 2230
Sample Response 2231
Post /radius/dictionary/{id} 2232
Description 2232
Request Parameter 2232
Request Headers 2232
Sample Request 2232
Sample Response 2233
Delete /radius/dictionary/{id} 2234
Description 2234
Request Parameter 2234
Request Headers 2234
Sample Request 2234
Sample Response 2235
Radius Health 2236
Get /radius/radius-health 2237
Description 2237
Request Headers 2237
Request Body Parameters 2237
Sample Request 2237
Sample Response 2238
Get /radius/radius-health-details 2239
Description 2239
Request Headers 2239
Request Body Parameters 2239
Sample Request 2239
Sample Response 2240
Get /radius/radius-health/timeline 2242
Description 2242
Request Headers 2242
Request Body Parameters 2242
Sample Request 2242

FortiNAC F 7.4.0 REST API 114

Fortinet Inc.
 Sample Response 2244
Get /radius/radius-health/latest 2245
Description 2245
Request Headers 2245
Request Body Parameters 2245
Sample Request 2245
Sample Response 2246
Get /radius/radius-health/snapshot-interval 2247
Description 2247
Request Headers 2247
Sample Request 2247
Sample Response 2248
Radius Server Configuration 2249
Get /radius/radius-server-config/activityStatus 2250
Description 2250
Request Headers 2250
Sample Request 2250
Sample Response 2251
Get /radius/radius-server-config/eap-types 2252
Description 2252
Request Headers 2252
Sample Request 2252
Sample Response 2253
Get /radius/radius-server-config/global 2254
Description 2254
Request Headers 2254
Sample Request 2254
Sample Response 2255
Get /radius/radius-server-config/{id} 2256
Description 2256
Request Parameter 2256
Request Headers 2256
Sample Request 2256
Sample Response 2257
Get /radius/radius-server-config/generateFastPacKey 2258
Description 2258
Request Headers 2258
Sample Request 2258
Sample Response 2259
Get /radius/radius-server-config/status 2260
Description 2260
Request Headers 2260
Sample Request 2260

FortiNAC F 7.4.0 REST API 115

Fortinet Inc.
 Sample Response 2261
Get /radius/radius-server-config 2262
Description 2262
Request Headers 2262
Request Body Parameters 2262
Sample Request 2262
Sample Response 2263
Get /radius/radius-server-config/log 2264
Description 2264
Request Headers 2264
Request Body Parameters 2264
Sample Request 2264
Sample Response 2265
Post /radius/radius-server-config/delete 2266
Description 2266
Request Headers 2266
Request Body Parameters 2266
Sample Request 2266
Sample Response 2267
Post /radius/radius-server-config/disable 2268
Description 2268
Request Headers 2268
Sample Request 2268
Sample Response 2269
Post /radius/radius-server-config/enable 2270
Description 2270
Request Headers 2270
Sample Request 2270
Sample Response 2271
Post /radius/radius-server-config/{id} 2272
Description 2272
Request Parameter 2272
Request Headers 2272
Sample Request 2272
Sample Response 2274
Post /radius/radius-server-config/nas/fixstale/{id} 2275
Description 2275
Request Parameter 2275
Request Headers 2275
Sample Request 2275
Sample Response 2276
Post /radius/radius-server-config/global 2278
Description 2278

FortiNAC F 7.4.0 REST API 116

Fortinet Inc.
 Request Headers 2278
Sample Request 2278
Sample Response 2279
Post /radius/radius-server-config 2280
Description 2280
Request Headers 2280
Sample Request 2280
Sample Response 2283
Delete /radius/radius-server-config/{id} 2285
Description 2285
Request Parameter 2285
Request Headers 2285
Sample Request 2285
Sample Response 2286
Rogue DHCP Detection 2287
Get /settings/device/rogue-DHCP-detection 2288
Description 2288
Request Headers 2288
Sample Request 2288
Sample Response 2289
Get /settings/device/rogue-DHCP-detection/vlans 2290
Description 2290
Request Headers 2290
Sample Request 2290
Sample Response 2291
Post /settings/device/rogue-DHCP-detection 2292
Description 2292
Request Headers 2292
Request Body Parameters 2292
Sample Request 2292
Sample Response 2293
Post /settings/device/rogue-DHCP-detection/vlan 2294
Description 2294
Request Headers 2294
Request Body Parameters 2294
Sample Request 2294
Sample Response 2295
Post /settings/device/rogue-DHCP-detection/vlan/delete 2296
Description 2296
Request Headers 2296
Request Body Parameters 2296
Sample Request 2296
Sample Response 2297

FortiNAC F 7.4.0 REST API 117

Fortinet Inc.
 Role 2298
Get /policy/role-mapping/{id}/usage 2299
Description 2299
Request Headers 2299
Request Body Parameters 2299
Sample Request 2299
Sample Response 2300
Get /policy/role-mapping/{id} 2301
Description 2301
Request Parameter 2301
Request Headers 2301
Sample Request 2301
Sample Response 2302
Get /policy/role-mapping 2304
Description 2304
Request Headers 2304
Request Body Parameters 2304
Sample Request 2304
Sample Response 2305
Get /policy/role-mapping/supporting-info 2307
Description 2307
Request Headers 2307
Sample Request 2307
Sample Response 2308
Get /policy/role-mapping/direct-configuration 2309
Description 2309
Request Headers 2309
Sample Request 2309
Sample Response 2310
Get /policy/role-mapping/membership 2311
Description 2311
Request Headers 2311
Request Body Parameters 2311
Sample Request 2311
Sample Response 2312
Post /policy/role-mapping 2314
Description 2314
Request Headers 2314
Sample Request 2314
Sample Response 2318
Post /policy/role-mapping/delete 2319
Description 2319
Request Headers 2319

FortiNAC F 7.4.0 REST API 118

Fortinet Inc.
 Request Body Parameters 2319
Sample Request 2319
Sample Response 2320
Post /policy/role-mapping/{id} 2321
Description 2321
Request Parameter 2321
Request Headers 2321
Sample Request 2321
Sample Response 2325
Post /policy/role-mapping/{id}/delete 2326
Description 2326
Request Headers 2326
Request Body Parameters 2326
Sample Request 2326
Sample Response 2327
Post /policy/role-mapping/rank/set 2328
Description 2328
Request Headers 2328
Request Body Parameters 2328
Sample Request 2328
Sample Response 2329
Post /policy/role-mapping/rank/swap 2330
Description 2330
Request Headers 2330
Request Body Parameters 2330
Sample Request 2330
Sample Response 2331
Delete /policy/role-mapping/{id} 2332
Description 2332
Request Parameter 2332
Request Headers 2332
Sample Request 2332
Sample Response 2333
Scan Result 2334
Get /host/scan 2335
Description 2335
Request Headers 2335
Request Body Parameters 2335
Sample Request 2335
Sample Response 2336
Get /host/scan/archives 2337
Description 2337
Request Headers 2337

FortiNAC F 7.4.0 REST API 119

Fortinet Inc.
 Sample Request 2337
Sample Response 2338
Get /host/scan/archive/import/status 2339
Description 2339
Request Headers 2339
Sample Request 2339
Sample Response 2340
Get /host/scan/count 2341
Description 2341
Request Headers 2341
Request Body Parameters 2341
Sample Request 2341
Sample Response 2342
Get /host/scan/count/all 2343
Description 2343
Request Headers 2343
Sample Request 2343
Sample Response 2344
Get /host/scan/{id} 2345
Description 2345
Request Parameter 2345
Request Headers 2345
Sample Request 2345
Sample Response 2346
Post /host/scan/archive/create 2347
Description 2347
Request Headers 2347
Request Body Parameters 2347
Sample Request 2347
Sample Response 2348
Post /host/scan/archive/import 2349
Description 2349
Request Headers 2349
Request Body Parameters 2349
Sample Request 2349
Sample Response 2350
Scanned Application 2351
Get /host/scanned-application 2352
Description 2352
Request Headers 2352
Request Body Parameters 2352
Sample Request 2352
Sample Response 2353

FortiNAC F 7.4.0 REST API 120

Fortinet Inc.
 Get /host/scanned-application/{id} 2354
Description 2354
Request Parameter 2354
Request Headers 2354
Sample Request 2354
Sample Response 2355
Get /host/scanned-application/for-host 2356
Description 2356
Request Headers 2356
Request Body Parameters 2356
Sample Request 2356
Sample Response 2357
Get /host/scanned-application/{id}/usage 2358
Description 2358
Request Parameter 2358
Request Headers 2358
Sample Request 2358
Sample Response 2359
Post /host/scanned-application/delete 2360
Description 2360
Request Headers 2360
Request Body Parameters 2360
Sample Request 2360
Sample Response 2361
Post /host/scanned-application/threat 2362
Description 2362
Request Headers 2362
Request Body Parameters 2362
Sample Request 2362
Sample Response 2363
Post /host/scanned-application/{id}/delete 2364
Description 2364
Request Parameter 2364
Request Headers 2364
Sample Request 2364
Sample Response 2365
Delete /host/scanned-application/{id} 2366
Description 2366
Request Parameter 2366
Request Headers 2366
Sample Request 2366
Sample Response 2367

FortiNAC F 7.4.0 REST API 121

Fortinet Inc.
 Scheduler 2368
Get /system/scheduler 2369
Description 2369
Request Headers 2369
Request Body Parameters 2369
Sample Request 2369
Sample Response 2370
Get /system/scheduler/{id} 2372
Description 2372
Request Parameter 2372
Request Headers 2372
Sample Request 2372
Sample Response 2373
Get /system/scheduler/count/all 2375
Description 2375
Request Headers 2375
Sample Request 2375
Sample Response 2376
Get /system/scheduler/count 2378
Description 2378
Request Headers 2378
Request Body Parameters 2378
Sample Request 2378
Sample Response 2379
Get /system/scheduler/{name}/running 2381
Description 2381
Request Parameter 2381
Request Headers 2381
Sample Request 2381
Sample Response 2382
Get /system/scheduler/activity-types 2383
Description 2383
Request Headers 2383
Sample Request 2383
Sample Response 2384
Post /system/scheduler/delete 2385
Description 2385
Request Headers 2385
Request Body Parameters 2385
Sample Request 2385
Sample Response 2386
Post /system/scheduler/{id}/delete 2387
Description 2387

FortiNAC F 7.4.0 REST API 122

Fortinet Inc.
 Request Parameter 2387
Request Headers 2387
Sample Request 2387
Sample Response 2388
Post /system/scheduler/{id}/disable 2389
Description 2389
Request Parameter 2389
Request Headers 2389
Sample Request 2389
Sample Response 2390
Post /system/scheduler/{id}/enable 2391
Description 2391
Request Parameter 2391
Request Headers 2391
Sample Request 2391
Sample Response 2392
Post /system/scheduler/run 2393
Description 2393
Request Headers 2393
Request Body Parameters 2393
Sample Request 2393
Sample Response 2394
Delete /system/scheduler/{id} 2395
Description 2395
Request Parameter 2395
Request Headers 2395
Sample Request 2395
Sample Response 2396
Security Event 2397
Get /policy/security-event 2398
Description 2398
Request Headers 2398
Request Body Parameters 2398
Sample Request 2398
Sample Response 2399
Get /policy/security-alarm 2400
Description 2400
Request Headers 2400
Request Body Parameters 2400
Sample Request 2400
Sample Response 2401
Get /policy/security-alarm/{id} 2403
Description 2403

FortiNAC F 7.4.0 REST API 123

Fortinet Inc.
 Request Parameter 2403
Request Headers 2403
Sample Request 2403
Sample Response 2404
Get /policy/security-alarm/{id}/monitor 2406
Description 2406
Request Parameter 2406
Request Headers 2406
Sample Request 2406
Sample Response 2407
Get /policy/security-event/{id} 2409
Description 2409
Request Parameter 2409
Request Headers 2409
Sample Request 2409
Sample Response 2410
Get /policy/security-event-summary/hosts/isolated 2411
Description 2411
Request Headers 2411
Request Body Parameters 2411
Sample Request 2411
Sample Response 2412
Get /policy/security-event-summary/alarms/top 2413
Description 2413
Request Headers 2413
Request Body Parameters 2413
Sample Request 2413
Sample Response 2414
Get /policy/security-event-summary/events/top 2415
Description 2415
Request Headers 2415
Request Body Parameters 2415
Sample Request 2416
Sample Response 2416
Get /policy/security-event-summary/dash-security-hosts-for-alarm 2417
Description 2417
Request Headers 2417
Request Body Parameters 2417
Sample Request 2417
Sample Response 2418
Get /policy/security-event-summary/hosts/top 2419
Description 2419
Request Headers 2419

FortiNAC F 7.4.0 REST API 124

Fortinet Inc.
 Request Body Parameters 2419
Sample Request 2419
Sample Response 2420
Get /policy/security-event-summary/hosts/remediated 2421
Description 2421
Request Headers 2421
Request Body Parameters 2421
Sample Request 2421
Sample Response 2422
Get /policy/security-event-summary/statistics 2423
Description 2423
Request Headers 2423
Request Body Parameters 2423
Sample Request 2423
Sample Response 2424
Get /policy/security-event/{id}/monitor 2425
Description 2425
Request Parameter 2425
Request Headers 2425
Sample Request 2425
Sample Response 2426
Post /policy/security-alarm/monitor/start 2427
Description 2427
Request Headers 2427
Sample Request 2427
Sample Response 2428
Post /policy/security-event/{id}/monitor/stop 2430
Description 2430
Request Parameter 2430
Request Headers 2430
Sample Request 2430
Sample Response 2431
Post /policy/security-event/monitor/start 2432
Description 2432
Request Headers 2432
Sample Request 2432
Sample Response 2433
Post /policy/security-alarm/{id}/monitor/stop 2434
Description 2434
Request Parameter 2434
Request Headers 2434
Sample Request 2434
Sample Response 2435

FortiNAC F 7.4.0 REST API 125

Fortinet Inc.
 Security Event Parser 2436
Get /settings/integration/security-event-parser 2437
Description 2437
Request Headers 2437
Request Body Parameters 2437
Sample Request 2437
Sample Response 2438
Get /settings/integration/security-event-parser/{id} 2440
Description 2440
Request Parameter 2440
Request Headers 2440
Sample Request 2440
Sample Response 2441
Get /settings/integration/security-event-parser/recent-syslog 2443
Description 2443
Request Headers 2443
Request Body Parameters 2443
Sample Request 2443
Sample Response 2444
Get /settings/integration/security-event-parser/{id}/usage 2445
Description 2445
Request Parameter 2445
Request Headers 2445
Sample Request 2445
Sample Response 2446
Post /settings/integration/security-event-parser 2447
Description 2447
Request Headers 2447
Sample Request 2447
Sample Response 2449
Post /settings/integration/security-event-parser/delete 2450
Description 2450
Request Headers 2450
Request Body Parameters 2450
Sample Request 2450
Sample Response 2451
Post /settings/integration/security-event-parser/disable 2452
Description 2452
Request Headers 2452
Request Body Parameters 2452
Sample Request 2452
Sample Response 2453

FortiNAC F 7.4.0 REST API 126

Fortinet Inc.
 Post /settings/integration/security-event-parser/{id} 2454
Description 2454
Request Parameter 2454
Request Headers 2454
Sample Request 2454
Sample Response 2456
Post /settings/integration/security-event-parser/parse-message 2457
Description 2457
Request Headers 2457
Request Body Parameters 2457
Sample Request 2457
Sample Response 2458
Post /settings/integration/security-event-parser/{id}/delete 2459
Description 2459
Request Parameter 2459
Request Headers 2459
Sample Request 2459
Sample Response 2460
Post /settings/integration/security-event-parser/{id}/test 2461
Description 2461
Request Headers 2461
Sample Request 2461
Sample Response 2463
Post /settings/integration/security-event-parser/enable 2464
Description 2464
Request Headers 2464
Request Body Parameters 2464
Sample Request 2464
Sample Response 2465
Delete /settings/integration/security-event-parser/{id} 2466
Description 2466
Request Parameter 2466
Request Headers 2466
Sample Request 2466
Sample Response 2467
Security Mgmnt Properties 2468
Get /settings/agent/properties 2469
Description 2469
Request Headers 2469
Sample Request 2469
Sample Response 2470
Post /settings/agent/properties 2471
Description 2471

FortiNAC F 7.4.0 REST API 127

Fortinet Inc.
 Request Headers 2471
Sample Request 2471
Sample Response 2473
Security Rule 2474
Get /policy/security-rule 2475
Description 2475
Request Headers 2475
Request Body Parameters 2475
Sample Request 2475
Sample Response 2476
Get /policy/security-rule-trigger 2478
Description 2478
Request Headers 2478
Request Body Parameters 2478
Sample Request 2478
Sample Response 2479
Get /policy/security-rule/{id} 2481
Description 2481
Request Parameter 2481
Request Headers 2481
Sample Request 2481
Sample Response 2482
Get /policy/security-rule-trigger/{id}/usage 2484
Description 2484
Request Parameter 2484
Request Headers 2484
Sample Request 2484
Sample Response 2485
Get /policy/security-rule-trigger/{id} 2486
Description 2486
Request Parameter 2486
Request Headers 2486
Sample Request 2486
Sample Response 2487
Post /policy/security-rule 2489
Description 2489
Request Headers 2489
Sample Request 2489
Sample Response 2494
Post /policy/security-rule/delete 2495
Description 2495
Request Headers 2495
Request Body Parameters 2495

FortiNAC F 7.4.0 REST API 128

Fortinet Inc.
 Sample Request 2495
Sample Response 2496
Post /policy/security-rule/{id}/disable 2497
Description 2497
Request Parameter 2497
Request Headers 2497
Sample Request 2497
Sample Response 2498
Post /policy/security-rule/{id}/enable 2499
Description 2499
Request Parameter 2499
Request Headers 2499
Sample Request 2499
Sample Response 2500
Post /policy/security-rule/{id}/delete 2501
Description 2501
Request Parameter 2501
Request Headers 2501
Sample Request 2501
Sample Response 2502
Post /policy/security-rule/{id} 2503
Description 2503
Request Parameter 2503
Request Headers 2503
Sample Request 2503
Sample Response 2508
Post /policy/security-rule/rank/set 2509
Description 2509
Request Headers 2509
Request Body Parameters 2509
Sample Request 2509
Sample Response 2510
Post /policy/security-rule/rank/swap 2511
Description 2511
Request Headers 2511
Request Body Parameters 2511
Sample Request 2511
Sample Response 2512
Post /policy/security-rule-trigger 2513
Description 2513
Request Headers 2513
Sample Request 2513
Sample Response 2515

FortiNAC F 7.4.0 REST API 129

Fortinet Inc.
 Post /policy/security-rule-trigger/{id}/delete 2516
Description 2516
Request Parameter 2516
Request Headers 2516
Sample Request 2516
Sample Response 2517
Post /policy/security-rule-trigger/delete 2518
Description 2518
Request Headers 2518
Request Body Parameters 2518
Sample Request 2518
Sample Response 2519
Post /policy/security-rule-trigger/{id} 2520
Description 2520
Request Parameter 2520
Request Headers 2520
Sample Request 2520
Sample Response 2522
Delete /policy/security-rule-trigger/{id} 2523
Description 2523
Request Parameter 2523
Request Headers 2523
Sample Request 2523
Sample Response 2524
Delete /policy/security-rule/{id} 2525
Description 2525
Request Parameter 2525
Request Headers 2525
Sample Request 2525
Sample Response 2526
Self Registration 2527
Get /user/guest-self-registration 2528
Description 2528
Request Headers 2528
Request Body Parameters 2528
Sample Request 2528
Sample Response 2529
Get /user/guest-self-registration/count 2530
Description 2530
Request Headers 2530
Request Body Parameters 2530
Sample Request 2530
Sample Response 2531

FortiNAC F 7.4.0 REST API 130

Fortinet Inc.
 Get /user/guest-self-registration/{id}/details 2532
Description 2532
Request Parameter 2532
Request Headers 2532
Sample Request 2532
Sample Response 2533
Get /user/guest-self-registration/count/all 2534
Description 2534
Request Headers 2534
Sample Request 2534
Sample Response 2535
Get /user/guest-self-registration/{id}/deny 2536
Description 2536
Request Parameter 2536
Request Headers 2536
Request Body Parameters 2536
Sample Request 2536
Sample Response 2537
Get /user/guest-self-registration/{id} 2538
Description 2538
Request Parameter 2538
Request Headers 2538
Sample Request 2538
Sample Response 2539
Post /user/guest-self-registration/{id}/approve 2540
Description 2540
Request Parameter 2540
Request Headers 2540
Request Body Parameters 2540
Sample Request 2540
Sample Response 2541
Server Management 2542
Get /system/properties/license 2543
Description 2543
Request Headers 2543
Sample Request 2543
Sample Response 2544
Get /system/properties/hardware 2545
Description 2545
Request Headers 2545
Sample Request 2545
Sample Response 2546

FortiNAC F 7.4.0 REST API 131

Fortinet Inc.
 Get /system/managed-server/{id}/properties 2547
Description 2547
Request Parameter 2547
Request Headers 2547
Sample Request 2547
Sample Response 2548
Get /system/managed-server/summary 2549
Description 2549
Request Headers 2549
Sample Request 2549
Sample Response 2550
Get /system/managed-server/{id}/scans 2551
Description 2551
Request Parameter 2551
Request Headers 2551
Sample Request 2551
Sample Response 2552
Get /system/managed-server/filtered-summary 2553
Description 2553
Request Headers 2553
Request Body Parameters 2553
Sample Request 2553
Sample Response 2554
Post /system/managed-server 2555
Description 2555
Request Headers 2555
Request Body Parameters 2555
Sample Request 2555
Sample Response 2556
Post /system/managed-server/delete 2557
Description 2557
Request Headers 2557
Request Body Parameters 2557
Sample Request 2557
Sample Response 2558
Post /system/managed-server/{id}/properties 2559
Description 2559
Request Parameter 2559
Request Headers 2559
Request Body Parameters 2559
Sample Request 2559
Sample Response 2560

FortiNAC F 7.4.0 REST API 132

Fortinet Inc.
 Post /system/managed-server/sync 2561
Description 2561
Request Headers 2561
Request Body Parameters 2561
Sample Request 2561
Sample Response 2562
Post /system/managed-server/ping 2563
Description 2563
Request Headers 2563
Request Body Parameters 2563
Sample Request 2563
Sample Response 2564
Service Connector 2565
Get /system/service-connector 2566
Description 2566
Request Headers 2566
Sample Request 2566
Sample Response 2567
SMS Provider 2568
Get /settings/integration/sms/count 2569
Description 2569
Request Headers 2569
Request Body Parameters 2569
Sample Request 2569
Sample Response 2570
Get /settings/integration/sms 2571
Description 2571
Request Headers 2571
Request Body Parameters 2571
Sample Request 2571
Sample Response 2572
Get /settings/integration/sms/count/all 2573
Description 2573
Request Headers 2573
Sample Request 2573
Sample Response 2574
Get /settings/integration/sms/global/max-length 2575
Description 2575
Request Headers 2575
Sample Request 2575
Sample Response 2576
Get /settings/integration/sms/{id} 2577
Description 2577

FortiNAC F 7.4.0 REST API 133

Fortinet Inc.
 Request Parameter 2577
Request Headers 2577
Sample Request 2577
Sample Response 2578
Get /settings/integration/sms/{id}/usage 2579
Description 2579
Request Parameter 2579
Request Headers 2579
Sample Request 2579
Sample Response 2580
Post /settings/agent/status-notifications 2581
Description 2581
Request Headers 2581
Sample Request 2581
Sample Response 2582
Post /settings/integration/sms/global/max-length 2583
Description 2583
Request Headers 2583
Request Body Parameters 2583
Sample Request 2583
Sample Response 2584
Post /settings/integration/sms 2585
Description 2585
Request Headers 2585
Sample Request 2585
Sample Response 2586
Post /settings/integration/sms/{id} 2587
Description 2587
Request Parameter 2587
Request Headers 2587
Sample Request 2587
Sample Response 2588
Post /settings/integration/sms/delete 2589
Description 2589
Request Headers 2589
Request Body Parameters 2589
Sample Request 2589
Sample Response 2590
Post /settings/integration/sms/{id}/disable 2591
Description 2591
Request Parameter 2591
Request Headers 2591
Sample Request 2591

FortiNAC F 7.4.0 REST API 134

Fortinet Inc.
 Sample Response 2592
Post /settings/integration/sms/{id}/enable 2593
Description 2593
Request Parameter 2593
Request Headers 2593
Sample Request 2593
Sample Response 2594
Post /settings/integration/sms/{id}/delete 2595
Description 2595
Request Parameter 2595
Request Headers 2595
Sample Request 2595
Sample Response 2596
Delete /settings/integration/sms/{id} 2597
Description 2597
Request Parameter 2597
Request Headers 2597
Sample Request 2597
Sample Response 2598
Status Notifications 2599
Get /settings/agent/status-notifications 2600
Description 2600
Request Headers 2600
Sample Request 2600
Sample Response 2601
Post /settings/agent/status-notifications 2602
Description 2602
Request Headers 2602
Sample Request 2602
Sample Response 2603
Supplicant Policy 2604
Get /policy/supplicant 2605
Description 2605
Request Headers 2605
Request Body Parameters 2605
Sample Request 2605
Sample Response 2606
Get /policy/supplicant/{id} 2608
Description 2608
Request Parameter 2608
Request Headers 2608
Sample Request 2608
Sample Response 2609

FortiNAC F 7.4.0 REST API 135

Fortinet Inc.
 Get /policy/supplicant-configuration/{id} 2611
Description 2611
Request Parameter 2611
Request Headers 2611
Sample Request 2611
Sample Response 2612
Get /policy/supplicant-configuration 2613
Description 2613
Request Headers 2613
Request Body Parameters 2613
Sample Request 2613
Sample Response 2614
Get /policy/supplicant-configuration/{id}/usage 2615
Description 2615
Request Parameter 2615
Request Headers 2615
Sample Request 2615
Sample Response 2616
Get /policy/supplicant-configuration/supporting-info 2617
Description 2617
Request Headers 2617
Sample Request 2617
Sample Response 2618
Get /policy/supplicant/supporting-info 2620
Description 2620
Request Headers 2620
Sample Request 2620
Sample Response 2621
Post /policy/supplicant 2623
Description 2623
Request Headers 2623
Sample Request 2623
Sample Response 2626
Post /policy/supplicant/delete 2627
Description 2627
Request Headers 2627
Request Body Parameters 2627
Sample Request 2627
Sample Response 2628
Post /policy/supplicant/disable 2629
Description 2629
Request Headers 2629
Request Body Parameters 2629

FortiNAC F 7.4.0 REST API 136

Fortinet Inc.
 Sample Request 2629
Sample Response 2630
Post /policy/supplicant/enable 2631
Description 2631
Request Headers 2631
Request Body Parameters 2631
Sample Request 2631
Sample Response 2632
Post /policy/supplicant/{id} 2633
Description 2633
Request Parameter 2633
Request Headers 2633
Sample Request 2633
Sample Response 2637
Post /policy/supplicant/{id}/delete 2638
Description 2638
Request Parameter 2638
Request Headers 2638
Sample Request 2638
Sample Response 2639
Post /policy/supplicant/{id}/disable 2640
Description 2640
Request Parameter 2640
Request Headers 2640
Sample Request 2640
Sample Response 2641
Post /policy/supplicant/{id}/enable 2642
Description 2642
Request Parameter 2642
Request Headers 2642
Sample Request 2642
Sample Response 2643
Post /policy/supplicant/rank/set 2644
Description 2644
Request Headers 2644
Request Body Parameters 2644
Sample Request 2644
Sample Response 2645
Post /policy/supplicant-configuration 2646
Description 2646
Request Headers 2646
Sample Request 2646
Sample Response 2648

FortiNAC F 7.4.0 REST API 137

Fortinet Inc.
 Post /policy/supplicant-configuration/delete 2649
Description 2649
Request Headers 2649
Request Body Parameters 2649
Sample Request 2649
Sample Response 2650
Post /policy/supplicant-configuration/{id} 2651
Description 2651
Request Parameter 2651
Request Headers 2651
Sample Request 2651
Sample Response 2653
Post /policy/supplicant-configuration/{id}/delete 2654
Description 2654
Request Parameter 2654
Request Headers 2654
Request Body Parameters 2654
Sample Request 2654
Sample Response 2655
Post /policy/supplicant/rank/swap 2656
Description 2656
Request Headers 2656
Request Body Parameters 2656
Sample Request 2656
Sample Response 2657
Delete /policy/supplicant/{id} 2658
Description 2658
Request Parameter 2658
Request Headers 2658
Sample Request 2658
Sample Response 2659
Delete /policy/supplicant-configuration/{id} 2660
Description 2660
Request Parameter 2660
Request Headers 2660
Sample Request 2660
Sample Response 2661
Syslog 2662
Get /settings/integration/syslog/{id} 2663
Description 2663
Request Parameter 2663
Request Headers 2663
Sample Request 2663

FortiNAC F 7.4.0 REST API 138

Fortinet Inc.
 Sample Response 2664
Get /settings/integration/syslog/{id}/usage 2666
Description 2666
Request Parameter 2666
Request Headers 2666
Sample Request 2666
Sample Response 2667
Get /settings/integration/syslog 2668
Description 2668
Request Headers 2668
Request Body Parameters 2668
Sample Request 2668
Sample Response 2669
Post /settings/integration/syslog/delete 2671
Description 2671
Request Headers 2671
Request Body Parameters 2671
Sample Request 2671
Sample Response 2672
Post /settings/integration/syslog/{id} 2673
Description 2673
Request Parameter 2673
Request Headers 2673
Sample Request 2673
Sample Response 2675
Post /settings/integration/syslog 2676
Description 2676
Request Headers 2676
Sample Request 2676
Sample Response 2678
Post /settings/integration/syslog/{id}/disable 2679
Description 2679
Request Parameter 2679
Request Headers 2679
Sample Request 2679
Sample Response 2680
Post /settings/integration/syslog/{id}/enable 2681
Description 2681
Request Parameter 2681
Request Headers 2681
Sample Request 2681
Sample Response 2682

FortiNAC F 7.4.0 REST API 139

Fortinet Inc.
 Post /settings/integration/syslog/{id}/delete 2683
Description 2683
Request Parameter 2683
Request Headers 2683
Sample Request 2683
Sample Response 2684
Delete /settings/integration/syslog/{id} 2685
Description 2685
Request Parameter 2685
Request Headers 2685
Sample Request 2685
Sample Response 2686
System 2687
Get /system/debug/log 2688
Description 2688
Request Headers 2688
Request Body Parameters 2688
Sample Request 2688
Sample Response 2689
Get /system/debug/database/relations 2690
Description 2690
Request Headers 2690
Request Body Parameters 2690
Sample Request 2690
Sample Response 2691
Get /system/debug/database/tables 2692
Description 2692
Request Headers 2692
Sample Request 2692
Sample Response 2693
Get /system/debug/database/table/data 2694
Description 2694
Request Headers 2694
Request Body Parameters 2694
Sample Request 2694
Sample Response 2695
Get /system/debug/elements 2696
Description 2696
Request Headers 2696
Request Body Parameters 2696
Sample Request 2696
Sample Response 2697

FortiNAC F 7.4.0 REST API 140

Fortinet Inc.
 Get /system/debug/elements/attributes 2698
Description 2698
Request Headers 2698
Request Body Parameters 2698
Sample Request 2698
Sample Response 2699
Get /system/debug/grabLogSnapshot-download 2700
Description 2700
Request Headers 2700
Request Body Parameters 2700
Sample Request 2700
Sample Response 2701
Get /system/debug/grabLogSnapshot-status 2702
Description 2702
Request Headers 2702
Request Body Parameters 2702
Sample Request 2702
Sample Response 2703
Get /system/debug/gui/experiments 2704
Description 2704
Request Headers 2704
Sample Request 2704
Sample Response 2705
Get /system/debug/logger-names 2706
Description 2706
Request Headers 2706
Sample Request 2706
Sample Response 2707
Get /system/debug/plugin/resources/reloaders 2708
Description 2708
Request Headers 2708
Sample Request 2708
Sample Response 2709
Get /system/debug/plugin-names 2710
Description 2710
Request Headers 2710
Sample Request 2710
Sample Response 2711
Get /system/debug/plugin-performance 2713
Description 2713
Request Headers 2713
Request Body Parameters 2713
Sample Request 2713

FortiNAC F 7.4.0 REST API 141

Fortinet Inc.
 Sample Response 2714
Get /system/debug/plugin-status 2715
Description 2715
Request Headers 2715
Sample Request 2715
Sample Response 2716
Post /system/debug/grabLogSnapshot-start 2717
Description 2717
Request Headers 2717
Sample Request 2717
Sample Response 2718
Post /system/debug/gui/snapshot 2719
Description 2719
Request Headers 2719
Request Body Parameters 2719
Sample Request 2719
Sample Response 2720
Post /system/debug/plugin 2721
Description 2721
Request Headers 2721
Request Body Parameters 2721
Sample Request 2721
Sample Response 2722
Post /system/debug/plugin/resources/reload 2723
Description 2723
Request Parameter 2723
Request Headers 2723
Request Body Parameters 2723
Sample Request 2724
Sample Response 2724
Post /system/debug/elements/attributes/delete 2725
Description 2725
Request Parameters 2725
Request Headers 2725
Request Body Parameters 2725
Sample Request 2726
Sample Response 2726
Post /system/debug/elements/attributes/set 2727
Description 2727
Request Parameters 2727
Request Headers 2727
Request Body Parameters 2727
Sample Request 2728

FortiNAC F 7.4.0 REST API 142

Fortinet Inc.
 Sample Response 2728
System Updates 2729
Get /settings/updates/system-updates 2730
Description 2730
Request Headers 2730
Request Body Parameters 2730
Sample Request 2730
Sample Response 2731
Get /settings/updates/system-updates/download-version 2732
Description 2732
Request Headers 2732
Sample Request 2732
Sample Response 2733
Get /settings/updates/system-updates/file-data 2734
Description 2734
Request Headers 2734
Sample Request 2734
Sample Response 2735
Get /settings/updates/system-updates/logs 2736
Description 2736
Request Headers 2736
Request Body Parameters 2736
Sample Request 2736
Sample Response 2737
Get /settings/updates/system-updates/password 2738
Description 2738
Request Headers 2738
Sample Request 2738
Sample Response 2739
Post /settings/updates/system-updates 2740
Description 2740
Request Headers 2740
Sample Request 2740
Sample Response 2741
Post /settings/updates/system-updates/test 2742
Description 2742
Request Headers 2742
Sample Request 2742
Sample Response 2743
Task 2744
Get /system/task 2745
Description 2745

FortiNAC F 7.4.0 REST API 143

Fortinet Inc.
 Request Headers 2745
Request Body Parameters 2745
Sample Request 2745
Sample Response 2746
Get /system/task/count 2747
Description 2747
Request Headers 2747
Request Body Parameters 2747
Sample Request 2747
Sample Response 2748
Get /system/task/count/all 2749
Description 2749
Request Headers 2749
Sample Request 2749
Sample Response 2750
Get /system/task/{id} 2751
Description 2751
Request Parameter 2751
Request Headers 2751
Sample Request 2751
Sample Response 2752
Get /system/task/{id}/usage 2753
Description 2753
Request Parameter 2753
Request Headers 2753
Sample Request 2753
Sample Response 2754
Post /system/task 2755
Description 2755
Request Headers 2755
Sample Request 2755
Sample Response 2756
Post /system/task/{id} 2757
Description 2757
Request Parameter 2757
Request Headers 2757
Sample Request 2757
Sample Response 2758
Post /system/task/delete 2759
Description 2759
Request Headers 2759
Request Body Parameters 2759
Sample Request 2759

FortiNAC F 7.4.0 REST API 144

Fortinet Inc.
 Sample Response 2760
Post /system/task/{id}/delete 2761
Description 2761
Request Parameter 2761
Request Headers 2761
Sample Request 2761
Sample Response 2762
Delete /system/task/{id} 2763
Description 2763
Request Parameter 2763
Request Headers 2763
Sample Request 2763
Sample Response 2764
TLS Service Configuration 2765
Get /settings/tls-service-configuration 2766
Description 2766
Request Headers 2766
Request Body Parameters 2766
Sample Request 2766
Sample Response 2767
Get /settings/tls-service-configuration/{id} 2768
Description 2768
Request Parameter 2768
Request Headers 2768
Sample Request 2768
Sample Response 2769
Get /settings/tls-service-configuration/{id}/usage 2770
Description 2770
Request Parameter 2770
Request Headers 2770
Sample Request 2770
Sample Response 2771
Get /settings/tls-service-configuration/radiusciphers 2772
Description 2772
Request Headers 2772
Sample Request 2772
Sample Response 2773
Get /settings/tls-service-configuration/aliases 2774
Description 2774
Request Headers 2774
Request Body Parameters 2774
Sample Request 2774
Sample Response 2775

FortiNAC F 7.4.0 REST API 145

Fortinet Inc.
 Post /settings/tls-service-configuration 2776
Description 2776
Request Headers 2776
Sample Request 2776
Sample Response 2777
Post /settings/tls-service-configuration/delete 2778
Description 2778
Request Headers 2778
Request Body Parameters 2778
Sample Request 2778
Sample Response 2779
Post /settings/tls-service-configuration/deploy 2780
Description 2780
Request Headers 2780
Sample Request 2780
Sample Response 2781
Post /settings/tls-service-configuration/{id}/delete 2782
Description 2782
Request Parameter 2782
Request Headers 2782
Sample Request 2782
Sample Response 2783
Post /settings/tls-service-configuration/{id} 2784
Description 2784
Request Parameter 2784
Request Headers 2784
Sample Request 2784
Sample Response 2785
Delete /settings/tls-service-configuration/{id} 2786
Description 2786
Request Parameter 2786
Request Headers 2786
Sample Request 2786
Sample Response 2787
Trap MIB 2788
Get /settings/integration/trap-mib 2789
Description 2789
Request Headers 2789
Sample Request 2789
Sample Response 2790
Post /settings/integration/trap-mib/add 2791
Description 2791
Request Headers 2791

FortiNAC F 7.4.0 REST API 146

Fortinet Inc.
 Request Body Parameters 2791
Sample Request 2792
Sample Response 2793
Post /settings/integration/trap-mib/delete 2794
Description 2794
Request Headers 2794
Sample Request 2794
Sample Response 2795
Post /settings/integration/trap-mib/mib-name 2796
Description 2796
Request Headers 2796
Request Body Parameters 2796
Sample Request 2797
Sample Response 2798
Post /settings/integration/trap-mib/update 2799
Description 2799
Request Headers 2799
Request Body Parameters 2799
Sample Request 2800
Sample Response 2801
Delete /settings/integration/trap-mib 2802
Description 2802
Request Headers 2802
Sample Request 2802
Sample Response 2803
Delete /settings/integration/trap-mib/trap-oid 2804
Description 2804
Request Headers 2804
Sample Request 2804
Sample Response 2805
Update 2806
Post /system/update/test 2807
Description 2807
Request Headers 2807
Request Body Parameters 2807
Sample Request 2808
Sample Response 2808
USB Detection 2809
Get /settings/agent/usb-detection 2810
Description 2810
Request Headers 2810
Sample Request 2810
Sample Response 2811

FortiNAC F 7.4.0 REST API 147

Fortinet Inc.
 Get /settings/agent/usb-detection/alarm-mappings 2812
Description 2812
Request Headers 2812
Sample Request 2812
Sample Response 2813
Get /settings/agent/usb-detection/usb-filters 2814
Description 2814
Request Headers 2814
Sample Request 2814
Sample Response 2815
Post /settings/agent/usb-detection/delete-filters 2816
Description 2816
Request Headers 2816
Request Body Parameters 2816
Sample Request 2816
Sample Response 2817
Post /settings/agent/usb-detection/usb-filters 2818
Description 2818
Request Headers 2818
Sample Request 2818
Sample Response 2819
Post /settings/agent/usb-detection 2820
Description 2820
Request Headers 2820
Sample Request 2820
Sample Response 2821
User 2822
Get /user/attributes/{name} 2823
Description 2823
Request Parameter 2823
Request Headers 2823
Sample Request 2823
Sample Response 2824
Get /user/attributes/user/{name} 2825
Description 2825
Request Parameter 2825
Request Headers 2825
Request Body Parameters 2825
Sample Request 2825
Sample Response 2826
Get /user/current-session/cache 2827
Description 2827
Request Headers 2827

FortiNAC F 7.4.0 REST API 148

Fortinet Inc.
 Request Body Parameters 2827
Sample Request 2827
Sample Response 2828
Get /user/current-session/feature-visibility 2829
Description 2829
Request Headers 2829
Sample Request 2829
Sample Response 2830
Get /user/current-session/bookmark 2831
Description 2831
Request Headers 2831
Request Body Parameters 2831
Sample Request 2831
Sample Response 2832
Get /user/current-session/timeout 2833
Description 2833
Request Headers 2833
Sample Request 2833
Sample Response 2834
Get /user/current-session/securityKey 2835
Description 2835
Request Headers 2835
Sample Request 2835
Sample Response 2836
Get /user/current-session/navigation-settings 2838
Description 2838
Request Headers 2838
Sample Request 2838
Sample Response 2839
Post /user/attributes/{name} 2841
Description 2841
Request Parameter 2841
Request Headers 2841
Request Body Parameters 2841
Sample Request 2841
Sample Response 2842
Post /user/attributes/user/{name} 2843
Description 2843
Request Parameter 2843
Request Headers 2843
Request Body Parameters 2843
Sample Request 2843
Sample Response 2844

FortiNAC F 7.4.0 REST API 149

Fortinet Inc.
 Post /user/current-session/bookmark/{id} 2845
Description 2845
Request Parameter 2845
Request Headers 2845
Sample Request 2845
Sample Response 2846
Post /user/current-session/bookmark/uuid/{uuid}/delete 2847
Description 2847
Request Parameter 2847
Request Headers 2847
Sample Request 2847
Sample Response 2848
Post /user/current-session/bookmark 2849
Description 2849
Request Headers 2849
Sample Request 2849
Sample Response 2850
Post /user/current-session/bookmark/delete 2851
Description 2851
Request Parameter 2851
Request Headers 2851
Request Body Parameters 2851
Sample Request 2851
Sample Response 2852
Post /user/current-session/bookmark/{id} 2853
Description 2853
Request Parameter 2853
Request Headers 2853
Sample Request 2853
Sample Response 2854
Post /user/current-session/bookmark/{id}/delete 2855
Description 2855
Request Parameter 2855
Request Headers 2855
Sample Request 2855
Sample Response 2856
Post /user/current-session/cache 2857
Description 2857
Request Headers 2857
Request Body Parameters 2857
Sample Request 2857
Sample Response 2858

FortiNAC F 7.4.0 REST API 150

Fortinet Inc.
 Post /user/current-session/bookmark/sync 2859
Description 2859
Request Headers 2859
Sample Request 2859
Sample Response 2860
Post /user/current-session/feature-visibility 2861
Description 2861
Request Headers 2861
Sample Request 2861
Sample Response 2862
Post /user/current-session/initialize-root-user 2863
Description 2863
Request Headers 2863
Request Body Parameters 2863
Sample Request 2863
Sample Response 2865
Post /user/current-session/login 2867
Description 2867
Request Headers 2867
Request Body Parameters 2867
Sample Request 2867
Sample Response 2868
Post /user/current-session/logout 2870
Description 2870
Request Headers 2870
Sample Request 2870
Sample Response 2871
Post /user/current-session/accept-usage-policy 2872
Description 2872
Request Headers 2872
Request Body Parameters 2872
Sample Request 2872
Sample Response 2873
Delete /user/current-session/bookmark/{id} 2875
Description 2875
Request Parameter 2875
Request Headers 2875
Sample Request 2875
Sample Response 2876
User Host Profile 2877
Get /policy/user-host-profile 2878
Description 2878
Request Headers 2878

FortiNAC F 7.4.0 REST API 151

Fortinet Inc.
 Request Body Parameters 2878
Sample Request 2878
Sample Response 2879
Get /policy/user-host-profile/{id} 2881
Description 2881
Request Parameter 2881
Request Headers 2881
Sample Request 2881
Sample Response 2882
Get /policy/user-host-profile/{id}/usage 2884
Description 2884
Request Parameter 2884
Request Headers 2884
Sample Request 2884
Sample Response 2885
Get /policy/user-host-profile/supporting-info 2886
Description 2886
Request Headers 2886
Sample Request 2886
Sample Response 2887
Post /policy/user-host-profile 2888
Description 2888
Request Headers 2888
Sample Request 2888
Sample Response 2890
Post /policy/user-host-profile/{id} 2891
Description 2891
Request Parameter 2891
Request Headers 2891
Sample Request 2891
Sample Response 2893
Post /policy/user-host-profile/delete 2894
Description 2894
Request Headers 2894
Request Body Parameters 2894
Sample Request 2894
Sample Response 2895
Post /policy/user-host-profile/{id}/delete 2896
Description 2896
Request Parameter 2896
Request Headers 2896
Sample Request 2896
Sample Response 2897

FortiNAC F 7.4.0 REST API 152

Fortinet Inc.
 Delete /policy/user-host-profile/{id} 2898
Description 2898
Request Parameter 2898
Request Headers 2898
Sample Request 2898
Sample Response 2899
User Record 2900
Get /user 2901
Description 2901
Request Headers 2901
Request Body Parameters 2901
Sample Request 2901
Sample Response 2902
Get /user/count 2904
Description 2904
Request Headers 2904
Request Body Parameters 2904
Sample Request 2904
Sample Response 2905
Get /user/allowed-hosts 2907
Description 2907
Request Headers 2907
Sample Request 2907
Sample Response 2908
Get /user/{id} 2909
Description 2909
Request Parameter 2909
Request Headers 2909
Sample Request 2909
Sample Response 2910
Get /user/count/all 2911
Description 2911
Request Headers 2911
Sample Request 2911
Sample Response 2912
Get /user/has-hosts 2914
Description 2914
Request Headers 2914
Sample Request 2914
Sample Response 2915
Get /user/{id}/get-policy 2916
Description 2916
Request Parameter 2916

FortiNAC F 7.4.0 REST API 153

Fortinet Inc.
 Request Headers 2916
Sample Request 2916
Sample Response 2917
Get /user/{id}/usage 2919
Description 2919
Request Parameter 2919
Request Headers 2919
Sample Request 2919
Sample Response 2920
Get /user/search-user-by-userID 2921
Description 2921
Request Headers 2921
Request Body Parameters 2921
Sample Request 2921
Sample Response 2922
Get /user/{id}/get-agent 2924
Description 2924
Request Headers 2924
Request Body Parameters 2924
Sample Request 2924
Sample Response 2925
Post /user 2926
Description 2926
Request Headers 2926
Sample Request 2926
Sample Response 2930
Post /user/allow-hosts 2931
Description 2931
Request Headers 2931
Sample Request 2931
Sample Response 2932
Post /user/delete 2933
Description 2933
Request Headers 2933
Request Body Parameters 2933
Sample Request 2933
Sample Response 2934
Post /user/disable 2935
Description 2935
Request Headers 2935
Request Body Parameters 2935
Sample Request 2935
Sample Response 2936

FortiNAC F 7.4.0 REST API 154

Fortinet Inc.
 Post /user/{id} 2937
Description 2937
Request Parameter 2937
Request Headers 2937
Sample Request 2937
Sample Response 2941
Post /user/enable 2942
Description 2942
Request Headers 2942
Request Body Parameters 2942
Sample Request 2942
Sample Response 2943
Post /user/{id}/disable 2944
Description 2944
Request Parameter 2944
Request Headers 2944
Sample Request 2944
Sample Response 2945
Post /user/{id}/enable 2946
Description 2946
Request Parameter 2946
Request Headers 2946
Sample Request 2946
Sample Response 2947
Post /user/set-role 2948
Description 2948
Request Headers 2948
Request Body Parameters 2948
Sample Request 2948
Sample Response 2949
Post /user/set-profile 2950
Description 2950
Request Headers 2950
Request Body Parameters 2950
Sample Request 2950
Sample Response 2951
Post /user/set-password 2952
Description 2952
Request Headers 2952
Request Body Parameters 2952
Sample Request 2952
Sample Response 2953

FortiNAC F 7.4.0 REST API 155

Fortinet Inc.
 Post /user/{id}/delete 2954
Description 2954
Request Parameter 2954
Request Headers 2954
Sample Request 2954
Sample Response 2955
Delete /user/{id} 2956
Description 2956
Request Parameter 2956
Request Headers 2956
Sample Request 2956
Sample Response 2957
Vulnerability Scanner 2958
Get /settings/integration/vulnerability-scanner 2959
Description 2959
Request Headers 2959
Request Body Parameters 2959
Sample Request 2959
Sample Response 2960
Get /settings/integration/vulnerability-scanner/{id} 2962
Description 2962
Request Parameter 2962
Request Headers 2962
Sample Request 2962
Sample Response 2963
Get /settings/integration/vulnerability-scanner/{id}/scans 2965
Description 2965
Request Parameter 2965
Request Headers 2965
Request Body Parameters 2965
Sample Request 2966
Sample Response 2966
Get /settings/integration/vulnerability-scanner/{id}/qualys-appliances 2967
Description 2967
Request Parameter 2967
Request Headers 2967
Request Body Parameters 2967
Sample Request 2968
Sample Response 2968
Get /settings/integration/vulnerability-scanner/{id}/usage 2969
Description 2969
Request Parameter 2969
Request Headers 2969

FortiNAC F 7.4.0 REST API 156

Fortinet Inc.
 Sample Request 2969
Sample Response 2970
Post /settings/integration/vulnerability-scanner 2971
Description 2971
Request Headers 2971
Sample Request 2971
Sample Response 2973
Post /settings/integration/vulnerability-scanner/delete 2974
Description 2974
Request Headers 2974
Request Body Parameters 2974
Sample Request 2974
Sample Response 2975
Post /settings/integration/vulnerability-scanner/{id} 2976
Description 2976
Request Parameter 2976
Request Headers 2976
Sample Request 2976
Sample Response 2978
Post /settings/integration/vulnerability-scanner/{id}/delete 2979
Description 2979
Request Parameter 2979
Request Headers 2979
Sample Request 2979
Sample Response 2980
Post /settings/integration/vulnerability-scanner/{id}/poll 2981
Description 2981
Request Parameter 2981
Request Headers 2981
Sample Request 2981
Sample Response 2982
Post /settings/integration/vulnerability-scanner/{id}/test 2983
Description 2983
Request Parameter 2983
Request Headers 2983
Request Body Parameters 2983
Sample Request 2984
Sample Response 2984
Delete /settings/integration/vulnerability-scanner/{id} 2985
Description 2985
Request Parameter 2985
Request Headers 2985
Sample Request 2985

FortiNAC F 7.4.0 REST API 157

Fortinet Inc.
 Sample Response 2986
Web Service Definition 2987
Get /settings/security/web-service-definition 2988
Description 2988
Request Headers 2988
Request Body Parameters 2988
Sample Request 2988
Sample Response 2989
Get /settings/security/web-service-definition/{id} 2990
Description 2990
Request Parameter 2990
Request Headers 2990
Sample Request 2990
Sample Response 2991
Get /settings/security/web-service-definition/{id}/usage 2992
Description 2992
Request Parameter 2992
Request Headers 2992
Sample Request 2992
Sample Response 2993
Post /settings/security/web-service-definition 2994
Description 2994
Request Headers 2994
Sample Request 2994
Sample Response 2995
Post /settings/security/web-service-definition/delete 2996
Description 2996
Request Headers 2996
Request Body Parameters 2996
Sample Request 2996
Sample Response 2997
Post /settings/security/web-service-definition/deploy 2998
Description 2998
Request Headers 2998
Sample Request 2998
Sample Response 2999
Post /settings/security/web-service-definition/{id} 3000
Description 3000
Request Parameter 3000
Request Headers 3000
Sample Request 3000
Sample Response 3001

FortiNAC F 7.4.0 REST API 158

Fortinet Inc.
 Post /settings/security/web-service-definition/{id}/delete 3002
Description 3002
Request Parameter 3002
Request Headers 3002
Sample Request 3002
Sample Response 3003
Delete /settings/security/web-service-definition/{id} 3004
Description 3004
Request Parameter 3004
Request Headers 3004
Sample Request 3004
Sample Response 3005
Winbind Configuration 3006
Get /winbind/config 3007
Description 3007
Request Headers 3007
Request Body Parameters 3007
Sample Request 3007
Sample Response 3008
Get /winbind/config/all 3009
Description 3009
Request Headers 3009
Sample Request 3009
Sample Response 3010
Get /winbind/config/global 3011
Description 3011
Request Headers 3011
Sample Request 3011
Sample Response 3012
Get /winbind/config/{id} 3013
Description 3013
Request Parameter 3013
Request Headers 3013
Sample Request 3013
Sample Response 3014
Get /winbind/config/log 3015
Description 3015
Request Headers 3015
Request Body Parameters 3015
Sample Request 3015
Sample Response 3016
Get /winbind/config/status 3017
Description 3017

FortiNAC F 7.4.0 REST API 159

Fortinet Inc.
 Request Headers 3017
Sample Request 3017
Sample Response 3018
Post /winbind/config 3019
Description 3019
Request Headers 3019
Sample Request 3019
Sample Response 3020
Post /winbind/config/delete 3021
Description 3021
Request Headers 3021
Request Body Parameters 3021
Sample Request 3021
Sample Response 3022
Post /winbind/config/disable 3023
Description 3023
Request Headers 3023
Sample Request 3023
Sample Response 3024
Post /winbind/config/enable 3025
Description 3025
Request Headers 3025
Sample Request 3025
Sample Response 3026
Post /winbind/config/{id} 3027
Description 3027
Request Parameter 3027
Request Headers 3027
Sample Request 3027
Sample Response 3029
Post /winbind/config/joinDomain/{id} 3030
Description 3030
Request Parameter 3030
Request Headers 3030
Request Body Parameters 3030
Sample Request 3031
Sample Response 3031
Delete /winbind/config/{id} 3032
Description 3032
Request Parameter 3032
Request Headers 3032
Sample Request 3032
Sample Response 3033

FortiNAC F 7.4.0 REST API 160

Fortinet Inc.
Introduction

Introduction

Welcome to the FortiNAC REST API!

The FortiNAC REST API allows you to perform configuration and monitoring operations on a FortiNAC
appliance or VM.
Supported APIs are shown in the bottom navigation tree. Select an API and all supported methods will be
displayed.
Access to the API is accomplished with an Authentication Bearer Token scheme. This will be detailed in the
following section.

FortiNAC F 7.4.0 REST API 161

Fortinet Inc.
Generate an API Token

Generate an API Token

Each REST API request requires an API token to be authenticated. An API token is generated by creating a new
REST API admin.

The steps below must be performed from the FortiNAC GUI as an Administrator with a
profile that allows Admin User creation and are customized for this tutorial.

Step 1: Determine your Source Address

The source address is needed to ensure the API token can only be used from trusted hosts. To obtain this
address, locate the IP Address of the machine you are going to be issuing the REST API request from. Keep
track of this for later use when we create the API user.

Step 2: Create an Administrator profile

The REST API admin should have the minimum permissions required to complete the
request.

In this tutorial, we will create a profile that only has Read access to the Host API.
1. On the FortiNAC GUI, select User > Admin Profiles and click the Add button.
2. Populate the fields as shown in the following images:

FortiNAC F 7.4.0 REST API 162

Fortinet Inc.
Generate an API Token

FortiNAC F 7.4.0 REST API 163

Fortinet Inc.
Generate an API Token

3. Click OK.

Step 3: Create the REST API Admin

Use the steps below to create the FortiNAC API admin.

1. On the FortiNAC GUI, select System > Admin Users and click the Add button.
2. Populate the User ID you would like to use.

3. Click OK.

FortiNAC F 7.4.0 REST API 164

Fortinet Inc.
Generate an API Token

4. Select the Admin Profile that you created in the previous steps and fill in the required additional
information.
5. Select the checkbox that indicates you want this User to have API access and generate a token.
6. Copy down this token as it will need to be included in your REST API calls and will be hidden after this
configuration is completed.
7. Make sure you enter the Allowed Subnets ( in this case the IP Address you used with a mask of 32 ).

8. Click OK to finish creating this User.

Next: Your First API Request on page 166

FortiNAC F 7.4.0 REST API 165

Fortinet Inc.
Your First API Request

Your First API Request

Make your first API request using curl ( which is what we’ll use in these examples ), or your favorite API testing
application suite ( for example, Postman ).
Note : All requests require that the Authorization: Bearer token be included in the header.
The following is an example curl command to retrieve all Hosts:
$ curl -k --location --request GET 'https://<YOUR-FORTNAC-ADDRESS>/api/v2/host' --header
'Authorization: Bearer <YOUR-API-TOKEN>'

This request will result in something similar to the following JSON output:

FortiNAC F 7.4.0 REST API 166

Fortinet Inc.
Your First API Request

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345051519875,
"id": 1,
"state": 0,
"notes": null,
"version": 1.6,
"creationTime": 1583431955310,
"validForTime": 1586023955310,
"lastSuccessfulPoll": 0,
"applications": null,
"hostName": null,
"owner": null,
"policy": null,
"hardwareType": null,
"status": 0,
"patchManagementVendor": null,
"patchManagementID": null,
"attributes": [],
"adapters": [
"00:50:56:98:31:0B"
],
"role": null,
"type": 9,
"directoryPolicyValue": null,
"agentVersion": null,
"agentID": null,
"agentSN": null,
"agentTag": null,
"agentPlatform": null,
"iconType": null,
"reValidation": false,
"criticality": null,
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": null,
"reValidationAction": {
"disable": false,
"version": 1.0
},
"domainId": -1,
"loggedOnUserId": null,
"policyHints": null,
"managedByMDM": false,
"mdmCompromised": false,
"mdmCompliance": false,
"mdmDataProtection": false,
"mdmPasscodePresent": false,
"adaptersAsString": "00:50:56:98:31:0B",
"operatingSystem": "Linux Fedora based",
"primaryMac": "00:50:56:98:31:0B",
"adapterIpAsString": "",
"adapterLocation": "",
"atRisk": false,
"pcserialNumber": null,
"adapterObjects": [
{
FortiNAC F 7.4.0 REST API
"landscape": 345051519875, 167
Fortinet Inc. "id": 1,
"identification": null,
"state": 0,
Your First API Request

You can compare this data to what you see in the Hosts>Host View in the FortiNAC GUI.
Now explore the rest of the REST API to see what you can accomplish!

Filtering :

By default, all results are returned from a query. Filtering of results is available for many of the API calls. Most
of the calls to get all or count all objects can be filtered in the following manner.
API requests are filtered by including the "filter" parameter in the request URL parameter:
/api/v2/cmdb/<endpoint>?filter=[key][operator][pattern]

The following filter operators are supported:

Operator Description

== Case insensitive match with pattern.

!= Does not match with pattern (case insensitive).

=@ Pattern found in object value (case insensitive).

Pattern not found in object value (case

!@
insensitive).

<= Value must be less than or equal to pattern.

< Value must be less than pattern.

>= Value must be greater than or equal to pattern.

> Value must be greater than pattern.

To create a complex query, filters can be combined as follows:

Combination How to use it

Logical OR Separate filters using commas ‘,’.

Separate filters using ampersands

Logical AND
‘&’.

Combining AND and Separate filters using commas ‘,’ and

OR ampersands ‘&’.

Note: The "." and "\" characters need to be escaped if they are part of a filter pattern.

Escaped
Character
Value

. \.

\ \\

FortiNAC F 7.4.0 REST API 168

Fortinet Inc.
Your First API Request

FortiNAC F 7.4.0 REST API 169

Fortinet Inc.
AAA Server

AAA Server

FortiNAC F 7.4.0 REST API 170

Fortinet Inc.
GET /settings/integration/aaa-mappings

GET /settings/integration/aaa-mappings

Description

Returns all RADIUS Domain Mappings

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 171

Fortinet Inc.
GET /settings/integration/aaa-mappings

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 172

Fortinet Inc.
Get /settings/integration/aaa-mappings/local-domains

Get /settings/integration/aaa-mappings/local-domains

Description

Returns the set of domains configured for roaming guests.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/local-domains

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 173

Fortinet Inc.
Get /settings/integration/aaa-mappings/local-domains

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
"string"
]
}

FortiNAC F 7.4.0 REST API 174

Fortinet Inc.
POST /settings/integration/aaa-mappings/local-domains/delete

POST /settings/integration/aaa-mappings/local-
domains/delete

Description

Deletes one or more domains from the list of local domains.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

domain Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/local-domains/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 175

Fortinet Inc.
POST /settings/integration/aaa-mappings/local-domains/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 176

Fortinet Inc.
GET /settings/integration/aaa-mappings/defaults

GET /settings/integration/aaa-mappings/defaults

Description

Returns the default RADIUS servers, primary and secondary, to use if there are no mappings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/defaults

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 177

Fortinet Inc.
GET /settings/integration/aaa-mappings/defaults

Sample Response

{
"status": "success",
"errorMessage": null,
"secondaryServerID": null,
"primaryServerID": null,
"primaryServerName": null,
"secondaryServerName": null,
"radiusProxyAuthEnabled": true,
"radiusProxyAcctEnabled": true,
"radiusProxyAuthPort": 1812,
"radiusProxyAcctPort": 1813
}

FortiNAC F 7.4.0 REST API 178

Fortinet Inc.
POST /settings/integration/aaa-mappings/local-domains

POST /settings/integration/aaa-mappings/local-domains

Description

Adds a new local domain for roaming guests.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/local-domains

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body domainName: fortinet

(application/x-www-
form-urlencoded)

FortiNAC F 7.4.0 REST API 179

Fortinet Inc.
POST /settings/integration/aaa-mappings/local-domains

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 180

Fortinet Inc.
POST /settings/integration/aaa-mappings

POST /settings/integration/aaa-mappings

Description

Adds a new RADIUS Domain Mapping.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

radiusServer Yes String

domainName Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 181

Fortinet Inc.
POST /settings/integration/aaa-mappings

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 182

Fortinet Inc.
POST /settings/integration/aaa-mappings/defaults

POST /settings/integration/aaa-mappings/defaults

Description

Saves the Primary and Secondary RADIUS servers to use as defaults.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

pimaryRadiusServer No Integer

secondaryRadiusServer No String

radiusProxyAuthEnabled
No boolean

radiusProxyAcctEnabled No boolean

radiusProxyAuthPort Yes Integer

radiusProxyAcctPort Yes Integer

FortiNAC F 7.4.0 REST API 183

Fortinet Inc.
POST /settings/integration/aaa-mappings/defaults

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/ettings/integration/aaa-

mappings/defaults

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body radiusProxyAuthPort: 1812

(application/x-www-form- radiusProxyAcctPort: 1813
urlencoded)

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 184

Fortinet Inc.
POST /settings/integration/aaa-mappings/delete

POST /settings/integration/aaa-mappings/delete

Description

Deletes one or more RADIUS Domain Mappings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body [
{
"server": "string",
"domain": "string"
}
]

FortiNAC F 7.4.0 REST API 185

Fortinet Inc.
POST /settings/integration/aaa-mappings/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 186

Fortinet Inc.
POST /settings/integration/aaa-mappings/swap

POST /settings/integration/aaa-mappings/swap

Description

Swaps the priority of two RADIUS Domain Mappings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

server1 Yes String

domain1 Yes String

server2 Yes String

domain2 Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa-

mappings/swaps

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 187

Fortinet Inc.
POST /settings/integration/aaa-mappings/swap

Request Body {
"server1": "string",
"domain1": "string",
"server2": "string",
"domain2": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 188

Fortinet Inc.
Access Point Management

Access Point Management

FortiNAC F 7.4.0 REST API 189

Fortinet Inc.
Get /settings/device/access-point-management

Get /settings/device/access-point-management

Description

Returns the currently configured Properties.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/access-

point-management

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 190

Fortinet Inc.
Get /settings/device/access-point-management

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"startIP": "10.0.0.1",
"endIP": "10.0.09",
"dbid": 131
}
]
}

FortiNAC F 7.4.0 REST API 191

Fortinet Inc.
Get /settings/device/access-point-management/ip-ranges

Get /settings/device/access-point-management/ip-ranges

Description

Returns the currently set IP Ranges.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/access-

point-management/ip-ranges

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 192

Fortinet Inc.
Get /settings/device/access-point-management/ip-ranges

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"startIP": "10.0.0.1",
"endIP": "10.0.09",
"dbid": 131
}
]
}

FortiNAC F 7.4.0 REST API 193

Fortinet Inc.
POST /settings/device/access-point-management

POST /settings/device/access-point-management

Description

Set the properties

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

updatePeriod Yes String

apmEnabled Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/access-

point-management

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body updatePeriod: xxxxx

apmEnabled: xxxxxxxxx

FortiNAC F 7.4.0 REST API 194

Fortinet Inc.
POST /settings/device/access-point-management

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 195

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges

Post /settings/device/access-point-management/ip-ranges

Description

Adds a new IP range.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

startIP Yes String Starting IP

endIP Yes String Ending IP

dbid Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/access-

point-management/ip-ranges

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body startIP:10.0.0.1

(application/x-www-form- endIP:10.0.0.9
urlencoded) dbid:32

FortiNAC F 7.4.0 REST API 196

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 197

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges/delete

Post /settings/device/access-point-management/ip-
ranges/delete

FortiNAC F 7.4.0 REST API 198

Fortinet Inc.
Description

Description

Deletes one or more IP Ranges.

Path Parameter

ID of the access point management.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes String dbid of the ip range

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/access-

point-management/ip-ranges/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:130

(application/x-www-form-
urlencoded)

FortiNAC F 7.4.0 REST API 199

Fortinet Inc.
Description

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 200

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges/{id}

Post /settings/device/access-point-management/ip-ranges/
{id}

Description

Modifies the existing ip ranges.

Request Parameter

ID of the access point management.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

startIP Yes String Starting IP

endIP Yes String Ending IP

dbid Yes Integer

FortiNAC F 7.4.0 REST API 201

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges/{id}

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/access-

point-management/ip-ranges

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body startIP: 10.1.0.1

(application/x-www-form- endIP:10.1.0.9
urlencoded) dbid: 64

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 202

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges/bulk

Post /settings/device/access-point-management/ip-
ranges/bulk

Description

Adds a new IP range.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

startIP Yes String Starting IP

endIP Yes String Ending IP

dbid Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/access-

point-management/ip-ranges/bulk

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 203

Fortinet Inc.
Post /settings/device/access-point-management/ip-ranges/bulk

Request Body startIP: 10.1.0.1

(application/x-www-form- endIP:10.1.0.9
urlencoded) dbid: 64

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 204

Fortinet Inc.
Adapter Record

Adapter Record

FortiNAC F 7.4.0 REST API 205

Fortinet Inc.
 Delete /adapter/{id}

Delete /adapter/{id}

Description

Deletes the Adapter record supplied, if it is not currently in use.

Parameter

Id(required), DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/adapter/47

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 206

Fortinet Inc.
Delete /adapter/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": null
}

FortiNAC F 7.4.0 REST API 207

Fortinet Inc.
Get /adapter

Get /adapter

Description

Returns all Adapter records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 208

Fortinet Inc.
Get /adapter

Sample Response

FortiNAC F 7.4.0 REST API 209

Fortinet Inc.
Get /adapter

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 52228714145,
"id": 38,
"identification": null,
"state": 0,
"type": 8,
"vendorName": "Rockwell Automation",
"parent": null,
"lastSuccessfulPoll": 1642682223041,
"status": 0,
"version": 3.3,
"user": null,
"clientState": 1,
"creationTime": 1641132672221,
"mediumType": null,
"location": "FortiGateRugged-60F
[192.168.130.1]:root:SR12DPTD21001461:port
1",
"container": "Manufacturing 130",
"dpcRuleId": -1,
"dpcRuleName": null,
"accessValue": "1",
"authType": -1,
"innerEapType": -1,
"outerEapType": -1,
"ips": [],
"hostID": 38,
"attributes": [
{
"version": 1.0,
"name": "ImageType",
"value": "cust_plc"
}
],
"device": true,
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "MOBIL_DESTROYED",
"elementType": 8,
"elementID": 38,
"elementName": null,
"message": null,
"timeOfEvent": 1694552002206,
"version": 1.3,
"time": 1694552002206,
"eventFormatString": "Adapter
5C:88:16:AF:A4:A2 Destroyed.",
"empty": false
},
"physicalAddress": "5C:88:16:AF:A4:A2",
"auditObjectName": "5C:88:16:AF:A4:A2",
"auditObjectType": {
"auditTableName": "DYNAMICAudit",
"mysqlTableName": "DYNAMIC",
FortiNAC F 7.4.0 "idnameQuery":
REST API "select id,physAddr from 210
Fortinet Inc. },
"addAuditSummary": "[]",
"creationEvent": {
Get /adapter

FortiNAC F 7.4.0 REST API 211

Fortinet Inc.
Get /adapter/count

Get /adapter/count

Description

Returns the count of all Adapter records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 212

Fortinet Inc.
Get /adapter/count

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 20
}

FortiNAC F 7.4.0 REST API 213

Fortinet Inc.
Get /adapter/count/all

Get /adapter/count/all

Description

Returns the count of all Adapter records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 214

Fortinet Inc.
Get /adapter/count/all

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 21
}

FortiNAC F 7.4.0 REST API 215

Fortinet Inc.
 Get /adapter/{id}

Get /adapter/{id}

Description

Returns the adapter record with the supplied DBID.

Request Parameter

Id(required), DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/38

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 216

Fortinet Inc.
Get /adapter/{id}

Sample Response

FortiNAC F 7.4.0 REST API 217

Fortinet Inc.
Get /adapter/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 52228714145,
"id": 38,
"identification": null,
"state": 0,
"type": 8,
"vendorName": "Rockwell Automation",
"parent": null,
"lastSuccessfulPoll": 1642682223041,
"status": 0,
"version": 3.3,
"user": null,
"clientState": 1,
"creationTime": 1641132672221,
"mediumType": null,
"location": "FortiGateRugged-60F
[192.168.130.1]:root:SR12DPTD21001461:port
1",
"container": "Manufacturing 130",
"dpcRuleId": -1,
"dpcRuleName": null,
"accessValue": "1",
"authType": -1,
"innerEapType": -1,
"outerEapType": -1,
"ips": [],
"hostID": 38,
"attributes": [
{
"version": 1.0,
"name": "ImageType",
"value": "cust_plc"
}
],
"device": true,
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "MOBIL_DESTROYED",
"elementType": 8,
"elementID": 38,
"elementName": null,
"message": null,
"timeOfEvent": 1694552002206,
"version": 1.3,
"time": 1694552002206,
"eventFormatString": "Adapter
5C:88:16:AF:A4:A2 Destroyed.",
"empty": false
},
"physicalAddress": "5C:88:16:AF:A4:A2",
"auditObjectName": "5C:88:16:AF:A4:A2",
"auditObjectType": {
"auditTableName": "DYNAMICAudit",
"mysqlTableName": "DYNAMIC",
FortiNAC F 7.4.0 "idnameQuery":
REST API "select id,physAddr from 218
Fortinet Inc. },
"addAuditSummary": "[]",
"creationEvent": {
Get /adapter/{id}

FortiNAC F 7.4.0 REST API 219

Fortinet Inc.
Get /adapter/{id}/usage

Get /adapter/{id}/usage

Description

Returns a list of records that reference this Adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Parameter

Id, DBID of the adapter record.

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/50/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 220

Fortinet Inc.
Get /adapter/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 221

Fortinet Inc.
Get /adapter/connected-to-ports

Get /adapter/connected-to-ports

Description

Returns a list of adapters connected to the ports provided.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

portID Required Array<Integer>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/connected-to-ports

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body portID: xx

FortiNAC F 7.4.0 REST API 222

Fortinet Inc.
Get /adapter/connected-to-ports

Sample Response

FortiNAC F 7.4.0 REST API 223

Fortinet Inc.
Get /adapter/connected-to-ports

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 52228714145,
"id": 38,
"identification": null,
"state": 0,
"type": 8,
"vendorName": "Rockwell Automation",
"parent": null,
"lastSuccessfulPoll": 1642682223041,
"status": 0,
"version": 3.3,
"user": null,
"clientState": 1,
"creationTime": 1641132672221,
"mediumType": null,
"location": "FortiGateRugged-60F
[192.168.130.1]:root:SR12DPTD21001461:port
1",
"container": "Manufacturing 130",
"dpcRuleId": -1,
"dpcRuleName": null,
"accessValue": "1",
"authType": -1,
"innerEapType": -1,
"outerEapType": -1,
"ips": [],
"hostID": 38,
"attributes": [
{
"version": 1.0,
"name": "ImageType",
"value": "cust_plc"
}
],
"device": true,
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "MOBIL_DESTROYED",
"elementType": 8,
"elementID": 38,
"elementName": null,
"message": null,
"timeOfEvent": 1694552002206,
"version": 1.3,
"time": 1694552002206,
"eventFormatString": "Adapter
5C:88:16:AF:A4:A2 Destroyed.",
"empty": false
},
"physicalAddress": "5C:88:16:AF:A4:A2",
"auditObjectName": "5C:88:16:AF:A4:A2",
"auditObjectType": {
"auditTableName": "DYNAMICAudit",
"mysqlTableName": "DYNAMIC",
FortiNAC F 7.4.0 "idnameQuery":
REST API "select id,physAddr from 224
Fortinet Inc. },
"addAuditSummary": "[]",
"creationEvent": {
Get /adapter/connected-to-ports

FortiNAC F 7.4.0 REST API 225

Fortinet Inc.
Get /adapter/for-host

Get /adapter/for-host

Description

Returns a list of adapters for the host object with the provided id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

hostID Required Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/for-host

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body hostID: xx

FortiNAC F 7.4.0 REST API 226

Fortinet Inc.
Get /adapter/for-host

Sample Response

FortiNAC F 7.4.0 REST API 227

Fortinet Inc.
Get /adapter/for-host

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 52228714145,
"id": 38,
"identification": null,
"state": 0,
"type": 8,
"vendorName": "Rockwell Automation",
"parent": null,
"lastSuccessfulPoll": 1642682223041,
"status": 0,
"version": 3.3,
"user": null,
"clientState": 1,
"creationTime": 1641132672221,
"mediumType": null,
"location": "FortiGateRugged-60F
[192.168.130.1]:root:SR12DPTD21001461:port
1",
"container": "Manufacturing 130",
"dpcRuleId": -1,
"dpcRuleName": null,
"accessValue": "1",
"authType": -1,
"innerEapType": -1,
"outerEapType": -1,
"ips": [],
"hostID": 38,
"attributes": [
{
"version": 1.0,
"name": "ImageType",
"value": "cust_plc"
}
],
"device": true,
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "MOBIL_DESTROYED",
"elementType": 8,
"elementID": 38,
"elementName": null,
"message": null,
"timeOfEvent": 1694552002206,
"version": 1.3,
"time": 1694552002206,
"eventFormatString": "Adapter
5C:88:16:AF:A4:A2 Destroyed.",
"empty": false
},
"physicalAddress": "5C:88:16:AF:A4:A2",
"auditObjectName": "5C:88:16:AF:A4:A2",
"auditObjectType": {
"auditTableName": "DYNAMICAudit",
"mysqlTableName": "DYNAMIC",
FortiNAC F 7.4.0 "idnameQuery":
REST API "select id,physAddr from 228
Fortinet Inc. },
"addAuditSummary": "[]",
"creationEvent": {
Get /adapter/for-host

FortiNAC F 7.4.0 REST API 229

Fortinet Inc.
 Get /adapter/{id}/get-port

Get /adapter/{id}/get-port

Description

Returns the port ID that the adapter was most recently connected to.

Request Parameter

Id(required), DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/adapter/7/get-port

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 230

Fortinet Inc.
Get /adapter/{id}/get-port

Sample Response

{
"status": "success",
"errorMessage": null
"result": []
}

FortiNAC F 7.4.0 REST API 231

Fortinet Inc.
Post /adapter

Post /adapter

Description

Adds a new Adapter record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-22T22:42:58.075Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",

FortiNAC F 7.4.0 REST API 232

Fortinet Inc.
Post /adapter

"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T22:42:58.075Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [

FortiNAC F 7.4.0 REST API 233

Fortinet Inc.
Post /adapter

"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},

FortiNAC F 7.4.0 REST API 234

Fortinet Inc.
Post /adapter

"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"host": {
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",

FortiNAC F 7.4.0 REST API 235

Fortinet Inc.
Post /adapter

"version": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",

FortiNAC F 7.4.0 REST API 236

Fortinet Inc.
Post /adapter

"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T22:42:58.075Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [

FortiNAC F 7.4.0 REST API 237

Fortinet Inc.
Post /adapter

"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},

FortiNAC F 7.4.0 REST API 238

Fortinet Inc.
Post /adapter

"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"dummyClient": "string",
"dummyDate": "2024-02-22T22:42:58.075Z",
"dummyApplications": [
{
"dbid": 0,

FortiNAC F 7.4.0 REST API 239

Fortinet Inc.
Post /adapter

"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-02-22T22:42:58.075Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T22:42:58.075Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"useKnownAdapters": true,
"groupId": 0,
"groupIds": [
0
],
"ssidid": 0,
"radiusfingerprint": {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-02-22T22:42:58.075Z",
"lastHeardTime": "2024-02-22T22:42:58.075Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",

FortiNAC F 7.4.0 REST API 240

Fortinet Inc.
Post /adapter

"tag": "string",
"imageFile": "string",
"id": 0
}
}
},
"managedByMDM": true,
"mdmCompromised": true,
"mdmCompliance": true,
"mdmDataProtection": true,
"mdmPasscodePresent": true,
"inTopology": true,
"adaptersAsString": "string",
"ip": "string",
"validForTimeOffline": 0,
"atRisk": true,
"notCommunicatingPersistentAgent": true,
"persistentAgent": true,
"notAuthenticated": true,
"userLoggedOn": true,
"vpnclient": true,
"typeLabel": "string",
"primaryMac": "string",
"adapterObjects": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"operatingSystem": "string",
"offlineAgeTime": 0,
"pcserialNumber": "string",
"vulnerabilityScanStatus": 0,
"vulnerabilityScanDate": 0,
"connectedAdapter": "string",
"adapterIpAsString": "string",
"adapterLocation": "string",
"adapterContainerAsString": "string",
"pendingAtRisk": true,
"disabled": true,
"agentPlatformEnum": "Windows",
"validTime": 0,
"expired": true,
"directoryDisabled": true,
"scanOnConnect": true,
"scanned": true,

FortiNAC F 7.4.0 REST API 241

Fortinet Inc.
Post /adapter

"dialUpClient": true,
"messageReceiver": true,
"connected": true,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 242

Fortinet Inc.
Post /adapter

"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"clientState": "string",
"creationTime": "2024-02-22T22:42:58.075Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"device": true,
"ipaddress": "string",
"userID": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"

FortiNAC F 7.4.0 REST API 243

Fortinet Inc.
Post /adapter

},
"pctype": "string",
"operatingSystem": "string",
"hardwareType": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"iconType": "string",
"allIPsString": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,

FortiNAC F 7.4.0 REST API 244

Fortinet Inc.
Post /adapter

"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string",
"hostName": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 245

Fortinet Inc.
Post /adapter

FortiNAC F 7.4.0 REST API 246

Fortinet Inc.
Post /adapter/delete

Post /adapter/delete

Description

Deletes the Adapter records or the records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Optional Array<String>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:38

FortiNAC F 7.4.0 REST API 247

Fortinet Inc.
Post /adapter/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 248

Fortinet Inc.
 Post /adapter/{id}

Post /adapter/{id}

Description

Updates an existing Adapter record in the database.

Parameter

Id(required), DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-22T22:42:58.075Z",
"status": 0,
"version": 0,

FortiNAC F 7.4.0 REST API 249

Fortinet Inc.
Post /adapter/{id}

"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T22:42:58.075Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [

FortiNAC F 7.4.0 REST API 250

Fortinet Inc.
Post /adapter/{id}

"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",

FortiNAC F 7.4.0 REST API 251

Fortinet Inc.
Post /adapter/{id}

"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"

FortiNAC F 7.4.0 REST API 252

Fortinet Inc.
Post /adapter/{id}

},
"host": {
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",

FortiNAC F 7.4.0 REST API 253

Fortinet Inc.
Post /adapter/{id}

"dummyUser": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-22T22:42:58.075Z",
"validForTime": "2024-02-22T22:42:58.075Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T22:42:58.075Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [

FortiNAC F 7.4.0 REST API 254

Fortinet Inc.
Post /adapter/{id}

"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",

FortiNAC F 7.4.0 REST API 255

Fortinet Inc.
Post /adapter/{id}

"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"

FortiNAC F 7.4.0 REST API 256

Fortinet Inc.
Post /adapter/{id}

},
"dummyClient": "string",
"dummyDate": "2024-02-22T22:42:58.075Z",
"dummyApplications": [
{
"dbid": 0,
"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-02-22T22:42:58.075Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T22:42:58.075Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"useKnownAdapters": true,
"groupId": 0,
"groupIds": [
0
],
"ssidid": 0,
"radiusfingerprint": {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-02-22T22:42:58.075Z",
"lastHeardTime": "2024-02-22T22:42:58.075Z",
"attributes": {

FortiNAC F 7.4.0 REST API 257

Fortinet Inc.
Post /adapter/{id}

"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}
},
"managedByMDM": true,
"mdmCompromised": true,
"mdmCompliance": true,
"mdmDataProtection": true,
"mdmPasscodePresent": true,
"inTopology": true,
"adaptersAsString": "string",
"ip": "string",
"validForTimeOffline": 0,
"atRisk": true,
"notCommunicatingPersistentAgent": true,
"persistentAgent": true,
"notAuthenticated": true,
"userLoggedOn": true,
"vpnclient": true,
"typeLabel": "string",
"primaryMac": "string",
"adapterObjects": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"operatingSystem": "string",
"offlineAgeTime": 0,
"pcserialNumber": "string",
"vulnerabilityScanStatus": 0,
"vulnerabilityScanDate": 0,
"connectedAdapter": "string",
"adapterIpAsString": "string",
"adapterLocation": "string",
"adapterContainerAsString": "string",
"pendingAtRisk": true,
"disabled": true,

FortiNAC F 7.4.0 REST API 258

Fortinet Inc.
Post /adapter/{id}

"agentPlatformEnum": "Windows",
"validTime": 0,
"expired": true,
"directoryDisabled": true,
"scanOnConnect": true,
"scanned": true,
"dialUpClient": true,
"messageReceiver": true,
"connected": true,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 259

Fortinet Inc.
Post /adapter/{id}

"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"clientState": "string",
"creationTime": "2024-02-22T22:42:58.075Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"device": true,
"ipaddress": "string",
"userID": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"

FortiNAC F 7.4.0 REST API 260

Fortinet Inc.
Post /adapter/{id}

},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pctype": "string",
"operatingSystem": "string",
"hardwareType": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"iconType": "string",
"allIPsString": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",

FortiNAC F 7.4.0 REST API 261

Fortinet Inc.
Post /adapter/{id}

"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-22T22:42:58.075Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string",
"hostName": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 262

Fortinet Inc.
Post /adapter/{id}

FortiNAC F 7.4.0 REST API 263

Fortinet Inc.
Post /adapter/{id}/delete

Post /adapter/{id}/delete

Description

Deletes the Adapter record supplied, if it is not currently in use.

Request Parameter

Id, DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/48/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 264

Fortinet Inc.
Post /adapter/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": null
}

FortiNAC F 7.4.0 REST API 265

Fortinet Inc.
Post /adapter/reprofile-rogues

Post /adapter/reprofile-rogues

Description

Reprofile the rogue devices with the supplied mac addresses.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

mac Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/reprofile-rogues

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body mac:xxxxxxxxx

FortiNAC F 7.4.0 REST API 266

Fortinet Inc.
Post /adapter/reprofile-rogues

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 267

Fortinet Inc.
Post /adapter/{id}/enable

Post /adapter/{id}/enable

Description

Enables the Adapter that matches the supplied DBID.

Request Parameter

Id, DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/38/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 268

Fortinet Inc.
Post /adapter/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 269

Fortinet Inc.
Post /adapter/{id}/disable

Post /adapter/{id}/disable

Description

Disables the Adapter that matches the supplied DBID.

Request Parameter

Id, DBID of the adapter record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/6/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 270

Fortinet Inc.
Post /adapter/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 271

Fortinet Inc.
Post /adapter/run-nmap-scan

Post /adapter/run-nmap-scan

Description

Run an NMAP scan for the adapter by the IP address provided.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

ip-address Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/adapter/run-nmap-scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip-address: xxxxxxxxx

FortiNAC F 7.4.0 REST API 272

Fortinet Inc.
Post /adapter/run-nmap-scan

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 273

Fortinet Inc.
Agent Update

Agent Update

FortiNAC F 7.4.0 REST API 274

Fortinet Inc.
Get /settings/agent/agent-update

Get /settings/agent/agent-update

Description

Returns the Agent Update details.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/agent-

update

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 275

Fortinet Inc.
Get /settings/agent/agent-update

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"winUUID": "",
"macUUID": "",
"updateWindowsEnabled": false,
"updateMacEnabled": false,
"allowDowngrade": false,
"maxUpdateAttempts": "3",
"winAgents": [
{
"uuid": "",
"label": ""
}
],
]
}
}

FortiNAC F 7.4.0 REST API 276

Fortinet Inc.
Post /settings/agent/agent-update

Post /settings/agent/agent-update

Description

Adds or modifies the Agent Update Settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/agent-

update

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"winUUID": "string",
"macUUID": "string",
"updateWindowsEnabled": true,
"updateMacEnabled": true,
"allowDowngrade": true,
"maxUpdateAttempts": "string",
"winAgents": [
{
"uuid": "string",
"label": "string"
}
],
"macAgents": [
{
"uuid": "string",

FortiNAC F 7.4.0 REST API 277

Fortinet Inc.
Post /settings/agent/agent-update

"label": "string"
}
]
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 278

Fortinet Inc.
Post /settings/agent/agent-update/reset-counter

Post /settings/agent/agent-update/reset-counter

Description

Reset the agent update counter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/agent-

update/reset-counter

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 279

Fortinet Inc.
Post /settings/agent/agent-update/reset-counter

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 280

Fortinet Inc.
Aging

Aging

FortiNAC F 7.4.0 REST API 281

Fortinet Inc.
Get /host/aging

Get /host/aging

Description

Returns the currently configured Host Aging Settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/aging

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 282

Fortinet Inc.
Get /host/aging

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"registeredHostValidTime": 0,
"registeredHostInactiveTime": 0,
"unregHostValidTime": 2592000000,
"unregHostInactiveTime": 1209600000,
"userValidTime": 0,
"userInactiveTime": 0,
"deleteRegHostsWithUser": true
}
}

FortiNAC F 7.4.0 REST API 283

Fortinet Inc.
Post /host/aging

Post /host/aging

Description

Adds or modifies the Host Aging Settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

registeredHostValidTime Yes Integer

registeredHostInactiveTime Yes Integer

unregHostValidTime Yes Integer

unregHostInactiveTime Yes Integer

userValidTime Yes Integer

userInactiveTime Yes Integer

deleteRegHostsWithUser Yes Boolean

FortiNAC F 7.4.0 REST API 284

Fortinet Inc.
Post /host/aging

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/aging

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body registeredHostValidTime: 0

registeredHostInactiveTime: 0
unregHostValidTime: 3592000000
unregHostInactiveTime: 2209600000
userValidTime: 0
userInactiveTime: 0
deleteRegHostsWithUser: true

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 285

Fortinet Inc.
Post /host/aging/clear-registered

Post /host/aging/clear-registered

Description

Clear Aging values for all registered and guest hosts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/aging/clear-

registered

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 286

Fortinet Inc.
Post /host/aging/clear-registered

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 287

Fortinet Inc.
Post /host/aging/clear-unregistered

Post /host/aging/clear-unregistered

Description

Clear Aging values for all unregistered(rogue) hosts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/aging/clear-

unregistered

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 288

Fortinet Inc.
Post /host/aging/clear-unregistered

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 289

Fortinet Inc.
Post /host/aging/clear-users

Post /host/aging/clear-users

Description

Clear Aging values for all Users.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/aging/clear-users

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 290

Fortinet Inc.
Post /host/aging/clear-users

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 291

Fortinet Inc.
Allowed Domains

Allowed Domains

FortiNAC F 7.4.0 REST API 292

Fortinet Inc.
Get /settings/device/allowed-domains

Get /settings/device/allowed-domains

Description

Returns the currently configured allowed domains info.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/allowed-

domains

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 293

Fortinet Inc.
Get /settings/device/allowed-domains

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"ipAddress": "209.91.113.53;209.91.113.52;",
"proxyAutoConfig": "",
"factoryDefaults": true,
"forwardOnly": false,
"domains": [
"accounts.google.com",
"amazonaws.com",
"apple.com",
"godaddy.com",
"mcafee.com",
"microsoft.com"
],
"reservedDomains": [
"DISCOVERY.PORTAL.BRADFORDNETWORKS.COM",
"PD-TEST",
"EXAMPLE.COM",
"."
]
}
}

FortiNAC F 7.4.0 REST API 294

Fortinet Inc.
Post /settings/device/allowed-domains

Post /settings/device/allowed-domains

Description

Sets the Allowed Domains.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/allowed-

domains

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"ipAddress": "string",
"proxyAutoConfig": "string",
"factoryDefaults": true,
"forwardOnly": true,
"domains": [
"string"
],
"reservedDomains": [
"string"
]
}

FortiNAC F 7.4.0 REST API 295

Fortinet Inc.
Post /settings/device/allowed-domains

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 296

Fortinet Inc.
Post /settings/device/allowed-domains/reset

Post /settings/device/allowed-domains/reset

Description

Resets Allowed Domains to Default.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/allowed-

domains/reset

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 297

Fortinet Inc.
Post /settings/device/allowed-domains/reset

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 298

Fortinet Inc.
Analytics

Analytics

FortiNAC F 7.4.0 REST API 299

Fortinet Inc.
Get /system/analytics-properties

Get /system/analytics-properties

Description

Returns the current activation key and server configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/analytics-

properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 300

Fortinet Inc.
Get /system/analytics-properties

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"analyticsActivationKey": "",
"analyticsServer": "analytics.example.com"
}
}

FortiNAC F 7.4.0 REST API 301

Fortinet Inc.
Post /system/analytics-properties

Post /system/analytics-properties

Description

Sets the analytics properties

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

analyticsActivationKey Yes String

analyticsServer Yes String

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/system/analytics-

properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body analyticsActivationKey: xxxxxxxxxx

analyticsServer: xxxxxxxxxxxx

FortiNAC F 7.4.0 REST API 302

Fortinet Inc.
Post /system/analytics-properties

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 303

Fortinet Inc.
Authentication Configuration

Authentication Configuration

FortiNAC F 7.4.0 REST API 304

Fortinet Inc.
Delete /policy/authentication-configuration/{id}

Delete /policy/authentication-configuration/{id}

Description

Deletes a single Authentication Configuration record by ID.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/authentication-

configuration/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 305

Fortinet Inc.
Delete /policy/authentication-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 306

Fortinet Inc.
Get /policy/authentication-configuration

Get /policy/authentication-configuration

Description

Returns a list of Authentication Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/authentication-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 307

Fortinet Inc.
Get /policy/authentication-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication
Policy - Fri Aug 25 13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
"reauthentication": false,
"reauthenticationTime": 0,
"errorMessage": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:35.000+0000",
"id": 1
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 308

Fortinet Inc.
Get /policy/authentication-configuration/{id}

Get /policy/authentication-configuration/{id}

Description

Returns a list of Authentication Configuration records matching the supplied filter.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/authentication-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 309

Fortinet Inc.
Get /policy/authentication-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication
Policy - Fri Aug 25 13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
"reauthentication": false,
"reauthenticationTime": 0,
"errorMessage": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:35.000+0000",
"id": 1
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 310

Fortinet Inc.
Get /policy/authentication-configuration/{id}/usage

Get /policy/authentication-configuration/{id}/usage

Description

Returns a list of records that reference this Authentication Configuration record.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/authentication-

configuration/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 311

Fortinet Inc.
Get /policy/authentication-configuration/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 312

Fortinet Inc.
Post /policy/authentication-configuration

Post /policy/authentication-configuration

Description

Creates a new Authentication Configuration record, updating instead if the profile has an existing DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"authenticationMethod": "string",
"authenticationTime": 0,
"authenticationTimeOffLine": 0,
"reauthentication": true,
"reauthenticationTime": 0,
"errorMessage": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T23:06:57.649Z",
"liveObj": {
"yamsEventTag": "string",

FortiNAC F 7.4.0 REST API 313

Fortinet Inc.
Post /policy/authentication-configuration

"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0
}

FortiNAC F 7.4.0 REST API 314

Fortinet Inc.
Post /policy/authentication-configuration/delete

Post /policy/authentication-configuration/delete

Description

Deletes a list of Authentication Configuration records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication-

configuration/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 2

FortiNAC F 7.4.0 REST API 315

Fortinet Inc.
Post /policy/authentication-configuration/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 316

Fortinet Inc.
Post /policy/authentication-configuration/{id}

Post /policy/authentication-configuration/{id}

Description

Updates an Authentication Configuration record.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"authenticationMethod": "string",
"authenticationTime": 0,
"authenticationTimeOffLine": 0,
"reauthentication": true,
"reauthenticationTime": 0,
"errorMessage": "string",

FortiNAC F 7.4.0 REST API 317

Fortinet Inc.
Post /policy/authentication-configuration/{id}

"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-16T21:14:48.050Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 318

Fortinet Inc.
Post /policy/authentication-configuration/{id}/delete

Post /policy/authentication-configuration/{id}/delete

Description

Deletes a single Authentication Configuration records by ID.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication-

configuration/3/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 319

Fortinet Inc.
Post /policy/authentication-configuration/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 320

Fortinet Inc.
Authentication Policy

Authentication Policy

FortiNAC F 7.4.0 REST API 321

Fortinet Inc.
Delete /policy/authentication/{id}

Delete /policy/authentication/{id}

Description

Deletes a single Authentication Policy record by ID.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/authentication/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 322

Fortinet Inc.
Delete /policy/authentication/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 323

Fortinet Inc.
Get /policy/authentication

Get /policy/authentication

Description

Returns a list of Authentication Policy records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/authentication

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 324

Fortinet Inc.
Get /policy/authentication

Sample Response

FortiNAC F 7.4.0 REST API 325

Fortinet Inc.
Get /policy/authentication

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"rank": 1,
"version": 0,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"profile": {
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"DBID": 1,
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"locationOperator": "OR",
"groupOperator": "OR",
"GUID": null,
"globalModifiedDate": "2023-08-25T17:40:35.000+0000",
"groupNames": [],
"weeklySchedule": null,
"groupIDs": [],
"locationIDs": [
8
],
"filterSet": [
{
"filterType": "adapter",
"hostType": "REG_HOST_OR_DEVICE",
"hostTypeIncIPPhone": "false"
}
],
"radiusFilterSet": [],
"locationNames": [
"Forced Authentication"
],
"catchAll": false
},
"configuration": {
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
"reauthentication": false,
"reauthenticationTime": 0,
"errorMessage": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"id": 1
},
"enabled": true,
"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",
"auditObj": null,
FortiNAC F"auditObjectName":
7.4.0 REST API "Global Authentication Conversion", 326
"auditObjectType":
Fortinet Inc. {
"auditTableName": "AuthenticationPolicyAudit",
"mysqlTableName": "AuthenticationPolicy",
Get /policy/authentication

FortiNAC F 7.4.0 REST API 327

Fortinet Inc.
Get /policy/authentication/{id}

Get /policy/authentication/{id}

Description

Returns a list of Authentication Policy records matching the id.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/authentication/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 328

Fortinet Inc.
Get /policy/authentication/{id}

Sample Response

FortiNAC F 7.4.0 REST API 329

Fortinet Inc.
Get /policy/authentication/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"rank": 1,
"version": 0,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"profile": {
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"DBID": 1,
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"locationOperator": "OR",
"groupOperator": "OR",
"GUID": null,
"globalModifiedDate": "2023-08-25T17:40:35.000+0000",
"groupNames": [],
"weeklySchedule": null,
"groupIDs": [],
"locationIDs": [
8
],
"filterSet": [
{
"filterType": "adapter",
"hostType": "REG_HOST_OR_DEVICE",
"hostTypeIncIPPhone": "false"
}
],
"radiusFilterSet": [],
"locationNames": [
"Forced Authentication"
],
"catchAll": false
},
"configuration": {
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
"reauthentication": false,
"reauthenticationTime": 0,
"errorMessage": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"id": 1
},
"enabled": true,
"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",
"auditObj": null,
FortiNAC F"auditObjectName":
7.4.0 REST API "Global Authentication Conversion", 330
"auditObjectType":
Fortinet Inc. {
"auditTableName": "AuthenticationPolicyAudit",
"mysqlTableName": "AuthenticationPolicy",
Get /policy/authentication/{id}

FortiNAC F 7.4.0 REST API 331

Fortinet Inc.
Post /policy/authentication

Post /policy/authentication

Description

Creates a new Authentication Policy record, updating instead if the supplied policy has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

dbid Yes Integer

name Yes String

enabled Yes boolean

rank Yes Integer

profile Yes Array

configuration Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 332

Fortinet Inc.
Post /policy/authentication

Content-Type: application/json

Request Body (Raw) {

"dbid": 1,
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug
25 13:40:35 EDT 2023",
"enabled": true,
"rank": 1,
"version": 0,
"profile": {
"DBID": 1
},
"configuration": {
"id": "1"
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 333

Fortinet Inc.
Post /policy/authentication/delete

Post /policy/authentication/delete

Description

Deletes a list of Authentication Policy records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:3

FortiNAC F 7.4.0 REST API 334

Fortinet Inc.
Post /policy/authentication/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 335

Fortinet Inc.
Post /policy/authentication/disable

Post /policy/authentication/disable

Description

Disables the supplied Authentication Policy.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 336

Fortinet Inc.
Post /policy/authentication/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 337

Fortinet Inc.
Post /policy/authentication/enable

Post /policy/authentication/enable

Description

Enables a list of Authentication Policy supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 338

Fortinet Inc.
Post /policy/authentication/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 339

Fortinet Inc.
Post /policy/authentication/{id}

Post /policy/authentication/{id}

Description

Updates an Authentication Policy record.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body (raw) {

"dbid": 1,
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug
25 13:40:35 EDT 2023",
"enabled": true,
"rank": 1,
"version": 0,
"profile": {
"DBID": 1

FortiNAC F 7.4.0 REST API 340

Fortinet Inc.
Post /policy/authentication/{id}

},
"configuration": {
"id": "1"
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 341

Fortinet Inc.
Post /policy/authentication/{id}/delete

Post /policy/authentication/{id}/delete

Description

Deletes a single Authentication Policy record by ID.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/2/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 342

Fortinet Inc.
Post /policy/authentication/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 343

Fortinet Inc.
Post /policy/authentication/{id}/disable

Post /policy/authentication/{id}/disable

Description

Disables the supplied Authentication Policy.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/1/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 344

Fortinet Inc.
Post /policy/authentication/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 345

Fortinet Inc.
Post /policy/authentication/{id}/enable

Post /policy/authentication/{id}/enable

Description

Enables the supplied Authentication Policy.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/1/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 346

Fortinet Inc.
Post /policy/authentication/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 347

Fortinet Inc.
Post /policy/authentication/rank/set

Post /policy/authentication/rank/set

Description

Creates a new Authentication Policy record, updating instead if the supplied policy has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:3

rank:3

FortiNAC F 7.4.0 REST API 348

Fortinet Inc.
Post /policy/authentication/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 349

Fortinet Inc.
Post /policy/authentication/rank/swap

Post /policy/authentication/rank/swap

Description

Swaps the rank position of the two supplied Authentication Policies.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/authentication/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id2:1

id1:2

FortiNAC F 7.4.0 REST API 350

Fortinet Inc.
Post /policy/authentication/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 351

Fortinet Inc.
Background Task

Background Task

FortiNAC F 7.4.0 REST API 352

Fortinet Inc.
Get /system/background-task

Get /system/background-task

Description

Returns all Background Task record which match the supplied filter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/background-task

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 353

Fortinet Inc.
Get /system/background-task

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"childTasks": null,
"yamsEventTag": null,
"auditObj": null,
"auditObjectName": "Guided Installation",
"auditObjectType": {
"auditTableName": "BackgroundTasksAudit",
"mysqlTableName": "BackgroundTasks",
"idnameQuery": "select ID, message from BackgroundTasks where ID
in"
},
"lastModifiedBy": "admin",
"lastModifiedDate": 1692985392000,
"lastChangeSummary": "[{\"oldVal\":\"\",\"field\":\"Date
Completed\",\"newVal\":\"2023-08-25\"}]",
"id": 1,
"message": "Guided Installation",
"assigner": 3,
"assignee": null,
"note": "Created automatically during system setup",
"dateCreated": "2023-08-25T17:38:32.000+0000",
"dateCompleted": "2023-08-25T17:43:12.000+0000",
"dateDue": null,
"previousTask": null,
"previousTaskComplete": false,
"notifyView": null,
"attributes": {
"OVERLAY": "Guided Install"
}
}
],
"filtered": 1,
"total": 12
}

FortiNAC F 7.4.0 REST API 354

Fortinet Inc.
Get /system/background-task/current-user

Get /system/background-task/current-user

Description

Retruns all tasks assigned to or created by the current user.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

includeAssigner Yes boolean

includeDescendants Yes boolean

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/background-

task/current-user

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body includeAssigner: False

includeDescendants: False

FortiNAC F 7.4.0 REST API 355

Fortinet Inc.
Get /system/background-task/current-user

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"childTasks": null,
"yamsEventTag": null,
"auditObj": null,
"auditObjectName": "Discover Network Devices",
"auditObjectType": {
"auditTableName": "BackgroundTasksAudit",
"mysqlTableName": "BackgroundTasks",
"idnameQuery": "select ID, message from BackgroundTasks
where ID in"
},
"lastModifiedBy": "admin",
"lastModifiedDate": 1692985112000,
"lastChangeSummary": "[]",
"id": 2,
"message": "Discover Network Devices",
"assigner": 3,
"assignee": null,
"note": "Created automatically during system setup",
"dateCreated": "2023-08-25T17:38:32.000+0000",
"dateCompleted": null,
"dateDue": null,
"previousTask": 1,
"previousTaskComplete": true,
"notifyView": "ee81d7ee-5b6c-472f-bcd9-3cb0522e60fa",
"attributes": {
"COMPLETE_ON_PROGRESS_UPDATE": "Discovery"
}
}
],
"filtered": null,
"total": null
}

FortiNAC F 7.4.0 REST API 356

Fortinet Inc.
Get /system/background-task/{id}

Get /system/background-task/{id}

Description

Returns the Background Task record with the supplied DBID.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/background-task/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 357

Fortinet Inc.
Get /system/background-task/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"childTasks": null,
"yamsEventTag": null,
"auditObj": null,
"auditObjectName": "Guided Installation",
"auditObjectType": {
"auditTableName": "BackgroundTasksAudit",
"mysqlTableName": "BackgroundTasks",
"idnameQuery": "select ID, message from BackgroundTasks where ID
in"
},
"lastModifiedBy": "admin",
"lastModifiedDate": 1692985392000,
"lastChangeSummary": "[{\"oldVal\":\"\",\"field\":\"Date
Completed\",\"newVal\":\"2023-08-25\"}]",
"id": 1,
"message": "Guided Installation",
"assigner": 3,
"assignee": null,
"note": "Created automatically during system setup",
"dateCreated": "2023-08-25T17:38:32.000+0000",
"dateCompleted": "2023-08-25T17:43:12.000+0000",
"dateDue": null,
"previousTask": null,
"previousTaskComplete": false,
"notifyView": null,
"attributes": {
"OVERLAY": "Guided Install"
}
}
],
"filtered": 1,
"total": 12
}

FortiNAC F 7.4.0 REST API 358

Fortinet Inc.
Post /system/background-task

Post /system/background-task

Description

Adds a new Background Task record to the database.

.Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/background-task

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"attributes": {},
"childTasks": null,
"yamsEventTag": null,
"auditObj": {},
"auditObjectName": "View Endpoint Fingerprints",
"auditObjectType": {
"auditTableName": "BackgroundTasksAudit",
"mysqlTableName": "BackgroundTasks",
"idnameQuery": "select ID, message from BackgroundTasks
where ID in"
},
"id": 12,
"message": "View Endpoint Fingerprints",
"assigner": 3,
"assignee": null,
"note": "Created automatically during system setup",
"dateCreated": 1692985112000,
"dateCompleted": null,
"dateDue": null,
"previousTask": "2",

FortiNAC F 7.4.0 REST API 359

Fortinet Inc.
Post /system/background-task

"previousTaskComplete": false,
"notifyView": "b0f391c0-adc8-11eb-8529-0242ac130003"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 360

Fortinet Inc.
Post /system/background-task/{id}

Post /system/background-task/{id}

Description

Updates an existing Background Task record in the database.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/background-task/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"attributes": {},
"childTasks": null,
"yamsEventTag": null,
"auditObj": {},
"auditObjectName": "View Endpoint Fingerprints",
"auditObjectType": {
"auditTableName": "BackgroundTasksAudit",
"mysqlTableName": "BackgroundTasks",

FortiNAC F 7.4.0 REST API 361

Fortinet Inc.
Post /system/background-task/{id}

"idnameQuery": "select ID, message from BackgroundTasks

where ID in"
},
"id": 12,
"message": "View Endpoint Fingerprints",
"assigner": 3,
"assignee": null,
"note": "Created automatically during system setup",
"dateCreated": 1692985112000,
"dateCompleted": null,
"dateDue": null,
"previousTask": "2",
"previousTaskComplete": false,
"notifyView": "b0f391c0-adc8-11eb-8529-0242ac130003"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 362

Fortinet Inc.
Post /system/background-task/{id}/complete

Post /system/background-task/{id}/complete

Description

Marks a Background Task record as complete.

Parameters

ID, or DBID of the profile.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/background-

task/1/complete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 363

Fortinet Inc.
Post /system/background-task/{id}/complete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 364

Fortinet Inc.
Post /system/background-task/delete

Post /system/background-task/delete

Description

Deletes the Background Task record or records supplied.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type Description

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/background-

task/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 365

Fortinet Inc.
Post /system/background-task/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 366

Fortinet Inc.
Certificate

Certificate

FortiNAC F 7.4.0 REST API 367

Fortinet Inc.
Get /settings/security/certificate-server

Get /settings/security/certificate-server

Description

Returns all server and/or client CA certificates uploaded to this server.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

type Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/security/certificate-

server

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 368

Fortinet Inc.
Get /settings/security/certificate-server

Sample Response

FortiNAC F 7.4.0 REST API 369

Fortinet Inc.
Get /settings/security/certificate-server

{
"status": "string",
"errorMessage": "string",
"possibleCerts": [
{
"name": "string",
"pathLabel": "string",
"requiresRestart": true,
"trustedCert": true,
"pendingCertDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pendingCertPrivateKey": "string",
"privateKey": "string",
"alias": "string",
"issuedTo": "string",
"issuedBy": "string",
"expiration": 0,
"status": "string",
"certificateDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"certificateChain": [
{}
]
}
],
"certs": [
{
"name": "string",
"pathLabel": "string",
"requiresRestart": true,
"trustedCert": true,
"pendingCertDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pendingCertPrivateKey": "string",
"privateKey": "string",
"alias": "string",
"issuedTo": "string",
"issuedBy": "string",
"expiration": 0,
"status": "string",
"certificateDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"certificateChain": [
{}
]
}
]
}
FortiNAC F 7.4.0 REST API 370
Fortinet Inc.
Get /settings/security/certificate-server

FortiNAC F 7.4.0 REST API 371

Fortinet Inc.
Post /settings/security/certificate-server/copy

Post /settings/security/certificate-server/copy

Description

Copies an uploaded certificate from one target to another.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

sourceCert Optional String

targetCert Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/copy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body sourceCert: xxx

targetCert: xxx

FortiNAC F 7.4.0 REST API 372

Fortinet Inc.
Post /settings/security/certificate-server/copy

Sample Response

{
"status": "string",
"errorMessage": "string",
"restartRequired": true
}

FortiNAC F 7.4.0 REST API 373

Fortinet Inc.
Post /settings/security/certificate-server/csr/generate

Post /settings/security/certificate-server/csr/generate

Description

Generates a Certificate Signing Request for the upload target.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/csr/generate

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"keyLength": 0,
"countryName": "string",
"state": "string",
"city": "string",
"orgName": "string",
"ou": "string",
"cn": "string",
"sans": [
"string"
],
"selfSigned": true,
"certType": "string",
"newTargetAlias": "string"
}

FortiNAC F 7.4.0 REST API 374

Fortinet Inc.
Post /settings/security/certificate-server/csr/generate

Sample Response

{
"status": "success",
"errorMessage": null,
"result": [],
"restartRequired": true
}

FortiNAC F 7.4.0 REST API 375

Fortinet Inc.
Post /settings/security/certificate-server/{name}

Post /settings/security/certificate-server/{name}

Description

Uploads a certificate chain and optional private key to the specified target name. Uploading certificates to a trust store
adds them to the list of trusted certificates.

Request Parameter

name, client root CA certificate.

Request Body Parameters

Name Required Type

targetType Optional String

privateKeyType Optional String

certs Optional Array

privateKey Optional Object

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

FortiNAC F 7.4.0 REST API 376

Fortinet Inc.
Post /settings/security/certificate-server/{name}

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/radsec

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body targetType: xxxxxxx

privateKeyType: xxxxxxxx
certs: xxxxxxxxxxx
privateKey: xxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"restartRequired": true
}

FortiNAC F 7.4.0 REST API 377

Fortinet Inc.
Post /settings/security/certificate-server/{name}/delete

Post /settings/security/certificate-server/{name}/delete

Description

Deletes trusted client root CA certificates by SHA1 fingerprint from the trust store at the specified target name.

Request Parameter

name, client root CA certificate.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

fingerprint Optional Array<String>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/radsec/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 378

Fortinet Inc.
Post /settings/security/certificate-server/{name}/delete

Request Body fingerprint: xxxxxxxxxxxxxxxxxxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"restartRequired": true
}

FortiNAC F 7.4.0 REST API 379

Fortinet Inc.
Post /settings/security/certificate-server/{name}/deleteServerCert

Post /settings/security/certificate-server/
{name}/deleteServerCert

Description

Deletes server certificate at the specified target.

Request Parameter

name, client root CA certificate.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/radsec/deleteServerCert

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 380

Fortinet Inc.
Post /settings/security/certificate-server/{name}/deleteServerCert

Sample Response

{
"status": "success",
"errorMessage": null,
"restartRequired": true
}

FortiNAC F 7.4.0 REST API 381

Fortinet Inc.
Post /settings/security/certificate-server/restart

Post /settings/security/certificate-server/restart

Description

Restarts the processes associated with the target certificate.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

target Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/certificate-

server/restart

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body target: xxxx

FortiNAC F 7.4.0 REST API 382

Fortinet Inc.
Post /settings/security/certificate-server/restart

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 383

Fortinet Inc.
Connection Log

Connection Log

FortiNAC F 7.4.0 REST API 384

Fortinet Inc.
Get /logging/connection

Get /logging/connection

Description

Returns all Network Session Event records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional count

sortKey Optional sortKey

sortDir Optional sortDir

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 385

Fortinet Inc.
Get /logging/connection

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2023-09-28T21:44:22.082Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 386

Fortinet Inc.
Get /logging/connection/count/all

Get /logging/connection/count/all

Description

Returns the count of Network Session Event records in the database.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/logging/connection/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 387

Fortinet Inc.
Get /logging/connection/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2023-09-28T21:44:22.082Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 388

Fortinet Inc.
Get /logging/connection/archive

Get /logging/connection/archive

Description

Returns the name of all connection log archives currently on the system.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection/archive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 389

Fortinet Inc.
Get /logging/connection/archive

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 390

Fortinet Inc.
Get /logging/connection/archive/import/status

Get /logging/connection/archive/import/status

Description

Returns the status of the most recent connection log archive import.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/logging/connection/archive/import/status

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 391

Fortinet Inc.
Get /logging/connection/archive/import/status

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "Finished importing from System01.\n0
records imported."
}

FortiNAC F 7.4.0 REST API 392

Fortinet Inc.
Get /logging/connection/by-session

Get /logging/connection/by-session

Description

Returns all Network Session Event records which match the supplied filter, but only the first matching Network Session
Event for each unique sessoin.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional count

sortKey Optional sortKey

sortDir Optional sortDir

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection/by-

session

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 393

Fortinet Inc.
Get /logging/connection/by-session

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2023-09-28T21:44:22.082Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 394

Fortinet Inc.
Get /logging/connection/count

Get /logging/connection/count

Description

Returns the count of Network Session Event records specified by the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/logging/connection/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 395

Fortinet Inc.
Get /logging/connection/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2023-09-28T21:44:22.082Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 396

Fortinet Inc.
Get /logging/connection/{id}

Get /logging/connection/{id}

Description

Returns the Network Session Event records with the supplied DBID

Parameter

ID: DBID of the Network Session Event.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 397

Fortinet Inc.
Get /logging/connection/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2023-09-28T21:44:22.082Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 398

Fortinet Inc.
Get /logging/connection/tabledatatotals

Get /logging/connection/tabledatatotals

Description

Returns the Table Data Totals for Network Session Events.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection/tabledatatotals

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 399

Fortinet Inc.
Get /logging/connection/tabledatatotals

Sample Response

{
"knownValues": {
"eventType": {
"values": [
{
"value": "PORT_CHANGE_TO_REGISTRATION",
"count": 0
},
{
"value": "PORT_CHANGE_TO_REMEDIATION",
"count": 0
},
{
"value": "PORT_CHANGE_TO_DEAD_END",
"count": 0
},
{
"value": "PORT_CHANGE_TO_DEFAULT",
"count": 0
}
]
},
"type": {
"values": [
{
"value": "28",
"count": 0
}
]
}
}
}

FortiNAC F 7.4.0 REST API 400

Fortinet Inc.
Get /logging/connection/top/hosts/activity

Get /logging/connection/top/hosts/activity

Description

Returns the top numbers of hosts by most connection activity.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request GET https://10.106.94.152:8443/api/v2/logging/connection/top/hosts/activity

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 401

Fortinet Inc.
Get /logging/connection/top/hosts/activity

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"mac": "string",
"owner": "string",
"host": "string",
"type": "string",
"count": 0
}
]

FortiNAC F 7.4.0 REST API 402

Fortinet Inc.
Get /logging/connection/top/users/connected-time

Get /logging/connection/top/users/connected-time

Description

Returns the top numbers of users by most connected time.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

numUsers Required Integer

filter Optional Array<String>

Sample Request

Request GET https://10.106.94.152:8443/api/v2/logging/connection/top/users/connected-time

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request numUsers: 7
Body

FortiNAC F 7.4.0 REST API 403

Fortinet Inc.
Get /logging/connection/top/users/connected-time

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"client": 0,
"ip": "string",
"port": 0,
"type": "string",
"time": "2024-04-11T18:32:50.883Z",
"ident": "string",
"mac": "string",
"location": "string",
"logicalNetwork": "string",
"netID": "string",
"cliConfigName": "string",
"sessionID": "string",
"isRadius": true,
"radiusAttributeDefaultGroup": "string",
"radiusAttributeLogicalNetworkGroup": "string",
"enhancedSnapshot": "string",
"eventType": "string",
"sessionDuration": 0,
"startingTime": "2024-04-11T18:32:50.883Z",
"endingTime": "2024-04-11T18:32:50.883Z"
}
]
}

FortiNAC F 7.4.0 REST API 404

Fortinet Inc.
Get /logging/connection/vlan/changes

Get /logging/connection/vlan/changes

Description

Returns the number of unique Hosts that had access to each Logical Network.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/connection/vlan/changes

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 405

Fortinet Inc.
Get /logging/connection/vlan/changes

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"logicalNetwork": "string",
"hostCount": 0
}
]
}

FortiNAC F 7.4.0 REST API 406

Fortinet Inc.
Post /logging/connection/archive/import

Post /logging/connection/archive/import

Description

Imports a collection log archive from the filesystem back into the database.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

fileName Optional Array<String>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/connection/archive/import

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 407

Fortinet Inc.
Post /logging/connection/archive/import

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 408

Fortinet Inc.
Container

Container

FortiNAC F 7.4.0 REST API 409

Fortinet Inc.
Delete /device/container/{id}

Delete /device/container/{id}

Description

Deletes the Container record supplied, if it is not currently in use.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/device/container/22

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 410

Fortinet Inc.
Delete /device/container/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 411

Fortinet Inc.
Get /device/container

Get /device/container

Description

Returns all Container records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

start Optional Integer

count Optional count

sortKey Optional sortKey

sortDir Optional sortDir

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/container

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 412

Fortinet Inc.
Get /device/container

Sample Response

FortiNAC F 7.4.0 REST API 413

Fortinet Inc.
Get /device/container

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 22,
"state": 0,
"elementClass": 4,
"role": null,
"name": "Wireless Controllers",
"type": null,
"protocol": null,
"status": 0,
"parent": "",
"suffix": null,
"version": 1.8,
"notes": null,
"description": null,
"group": null,
"pollingInterval": 10,
"lastPoll": null,
"lastSuccessfulPoll": "2023-08-25T17:40:35.853+0000",
"mibs": [],
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_DESTROYED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.038+0000",
"version": 1.3,
"time": 1695762468038,
"empty": false,
"eventFormatString": "Container Wireless Controllers destroyed."
},
"creationEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_CREATED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
"version": 1.3,
"time": 1695762468040,
"empty": false,
"eventFormatString": "Container Wireless Controllers created."
},
"establishedEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "CONTACT_ESTABLISHED",
"elementType": 4,
FortiNAC F 7.4.0 "elementID":
REST API 22, 414
Fortinet Inc. "elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
Get /device/container

FortiNAC F 7.4.0 REST API 415

Fortinet Inc.
Get /device/container/count

Get /device/container/count

Description

Returns the count of Container records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/container/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 416

Fortinet Inc.
Get /device/container/count

Sample Response

FortiNAC F 7.4.0 REST API 417

Fortinet Inc.
Get /device/container/count

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 22,
"state": 0,
"elementClass": 4,
"role": null,
"name": "Wireless Controllers",
"type": null,
"protocol": null,
"status": 0,
"parent": "",
"suffix": null,
"version": 1.8,
"notes": null,
"description": null,
"group": null,
"pollingInterval": 10,
"lastPoll": null,
"lastSuccessfulPoll": "2023-08-25T17:40:35.853+0000",
"mibs": [],
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_DESTROYED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.038+0000",
"version": 1.3,
"time": 1695762468038,
"empty": false,
"eventFormatString": "Container Wireless Controllers destroyed."
},
"creationEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_CREATED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
"version": 1.3,
"time": 1695762468040,
"empty": false,
"eventFormatString": "Container Wireless Controllers created."
},
"establishedEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "CONTACT_ESTABLISHED",
"elementType": 4,
FortiNAC F 7.4.0 "elementID":
REST API 22, 418
Fortinet Inc. "elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
Get /device/container/count

FortiNAC F 7.4.0 REST API 419

Fortinet Inc.
Get /device/container/count/all

Get /device/container/count/all

Description

Returns the count of Container records in the database.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/container/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 420

Fortinet Inc.
Get /device/container/count/all

Sample Response

FortiNAC F 7.4.0 REST API 421

Fortinet Inc.
Get /device/container/count/all

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 22,
"state": 0,
"elementClass": 4,
"role": null,
"name": "Wireless Controllers",
"type": null,
"protocol": null,
"status": 0,
"parent": "",
"suffix": null,
"version": 1.8,
"notes": null,
"description": null,
"group": null,
"pollingInterval": 10,
"lastPoll": null,
"lastSuccessfulPoll": "2023-08-25T17:40:35.853+0000",
"mibs": [],
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_DESTROYED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.038+0000",
"version": 1.3,
"time": 1695762468038,
"empty": false,
"eventFormatString": "Container Wireless Controllers destroyed."
},
"creationEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_CREATED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
"version": 1.3,
"time": 1695762468040,
"empty": false,
"eventFormatString": "Container Wireless Controllers created."
},
"establishedEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "CONTACT_ESTABLISHED",
"elementType": 4,
FortiNAC F 7.4.0 "elementID":
REST API 22, 422
Fortinet Inc. "elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
Get /device/container/count/all

FortiNAC F 7.4.0 REST API 423

Fortinet Inc.
Get /device/container/{id}

Get /device/container/{id}

Description

Returns all Container records which match the supplied filter.

Parameter

ID, DBID of the container record.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/container/22

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 424

Fortinet Inc.
Get /device/container/{id}

Sample Response

FortiNAC F 7.4.0 REST API 425

Fortinet Inc.
Get /device/container/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 22,
"state": 0,
"elementClass": 4,
"role": null,
"name": "Wireless Controllers",
"type": null,
"protocol": null,
"status": 0,
"parent": "",
"suffix": null,
"version": 1.8,
"notes": null,
"description": null,
"group": null,
"pollingInterval": 10,
"lastPoll": null,
"lastSuccessfulPoll": "2023-08-25T17:40:35.853+0000",
"mibs": [],
"destroyEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_DESTROYED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.038+0000",
"version": 1.3,
"time": 1695762468038,
"empty": false,
"eventFormatString": "Container Wireless Controllers destroyed."
},
"creationEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "DOMAIN_CREATED",
"elementType": 4,
"elementID": 22,
"elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
"version": 1.3,
"time": 1695762468040,
"empty": false,
"eventFormatString": "Container Wireless Controllers created."
},
"establishedEvent": {
"landscape": -1,
"id": -1,
"state": 1,
"name": "CONTACT_ESTABLISHED",
"elementType": 4,
FortiNAC F 7.4.0 "elementID":
REST API 22, 426
Fortinet Inc. "elementName": null,
"message": null,
"timeOfEvent": "2023-09-26T21:07:48.040+0000",
Get /device/container/{id}

FortiNAC F 7.4.0 REST API 427

Fortinet Inc.
Get /device/container/{id}/usage

Get /device/container/{id}/usage

Description

Returns a list of Container records that reference this record.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/container/23/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 428

Fortinet Inc.
Get /device/container/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 429

Fortinet Inc.
Get /device/container/monitor/{id}

Get /device/container/monitor/{id}

Description

Get all changes to Container records since the Events were last polled.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/container/monitor/22

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 430

Fortinet Inc.
Get /device/container/monitor/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-04-11T21:19:23.306Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"updated": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-04-11T21:19:23.306Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 431

Fortinet Inc.
Post /device/container

Post /device/container

Description

Adds a new container record to the database.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"note": "string",
"defaultAPLocation": true
}

FortiNAC F 7.4.0 REST API 432

Fortinet Inc.
Post /device/container

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 433

Fortinet Inc.
Post /device/container/{id}

Post /device/container/{id}

Description

Updates an existing Container record in the database.

Parameter

ID, DBID of the container record.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"note": "string",
"defaultAPLocation": true
}

FortiNAC F 7.4.0 REST API 434

Fortinet Inc.
Post /device/container/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 435

Fortinet Inc.
Post /device/container/delete

Post /device/container/delete

Description

Deletes the Container record supplied, if they are not currently in use.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:23

FortiNAC F 7.4.0 REST API 436

Fortinet Inc.
Post /device/container/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 437

Fortinet Inc.
Post /device/container/{id}/delete

Post /device/container/{id}/delete

Description

Deletes the Container record supplied, if it is not currently in use.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container/23/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 438

Fortinet Inc.
Post /device/container/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 439

Fortinet Inc.
Post /device/container/monitor/start

Post /device/container/monitor/start

Description

Begins collecting changes made to Container records matching the supplied filter.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"maxRowLimit": 0,
"methodNames": [
"string"
],
"groupIDsOperator": "AND",
"groupNames": [
"string"
],
"groupNamesOperator": "AND",

FortiNAC F 7.4.0 REST API 440

Fortinet Inc.
Post /device/container/monitor/start

"sortColumn": "string",
"queryFilters": [
[
{
"comparisonType": "EQUALS",
"origPropName": "string",
"matchNull": true,
"matchNonNull": true,
"actualValue": {},
"notFilter": true,
"values": [
{}
],
"propName": "string",
"allowNotFilter": true,
"allowMultiTermFilter": true,
"criterion": {},
"debugString": "string",
"stringValue": "string",
"enabled": true
}
]
],
"id": 0,
"identification": "string",
"ids": [
0
],
"attributeNames": [
"string"
],
"changeMask": 0,
"state": "string",
"operation": "DB_ADD",
"requestString": "string",
"role": "string",
"elementClass": "string",
"physicalAddress": "string",
"hardwareType": "string",
"domainName": "string",
"protocol": "string",
"notes": "string",
"elementIDs": [
0
],
"sysOid": "string",
"elementClasses": true,
"attributeSearchValues": [
"string"
],
"typeList": [
"string"
],
"suffix": "string",
"type": "string",

FortiNAC F 7.4.0 REST API 441

Fortinet Inc.
Post /device/container/monitor/start

"status": "string",
"description": "string",
"name": "string",
"parent": "string",
"methodSearchValues": [
{}
],
"sortEnabled": true,
"sortAscending": true,
"sortDescending": true,
"groupIDsToFilter": [
0
],
"queryFilterWhereClause": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"total": 0,
"monitorID": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-04-11T21:14:55.415Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 442

Fortinet Inc.
Post /device/container/monitor/{id}/stop

Post /device/container/monitor/{id}/stop

Description

Stop collecting changes made to Container records for the specified monitor.

Parameters

ID, DBID of the container.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/container/monitor/23/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 443

Fortinet Inc.
Post /device/container/monitor/{id}/stop

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 444

Fortinet Inc.
Credential Config

Credential Config

FortiNAC F 7.4.0 REST API 445

Fortinet Inc.
Get /settings/agent/credential-config

Get /settings/agent/credential-config

Description

Returns the currently configured Credentials for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/credential-

config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 446

Fortinet Inc.
Get /settings/agent/credential-config

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"allAuthTypes": {
"RADIUS": "RADIUS",
"LDAP": "LDAP",
"CM": "Local",
"RADIUS/LDAP": "RADIUS/LDAP"
},
"regAsDevice": "false",
"authTypeAgent": "LDAP",
"regTypeAgent": "LDAP",
"regEnabled": "true"
}
}

FortiNAC F 7.4.0 REST API 447

Fortinet Inc.
Post /settings/agent/credential-config

Post /settings/agent/credential-config

Description

Sets the credential configuration for Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/credential-

config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"allAuthTypes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"regAsDevice": "string",
"authTypeAgent": "string",
"regTypeAgent": "string",
"regEnabled": "string"
}

FortiNAC F 7.4.0 REST API 448

Fortinet Inc.
Post /settings/agent/credential-config

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 449

Fortinet Inc.
Dashboard

Dashboard

FortiNAC F 7.4.0 REST API 450

Fortinet Inc.
Delete /user/dashboard/{id}

Delete /user/dashboard/{id}

Description

Deletes a single user dashboard record by ID.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/dashboard/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 451

Fortinet Inc.
Delete /user/dashboard/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 452

Fortinet Inc.
Get /user/dashboard/agent-summary

Get /user/dashboard/agent-summary

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/agent-

summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 453

Fortinet Inc.
Get /user/dashboard/agent-summary

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 454

Fortinet Inc.
Get /user/dashboard/device-summary

Get /user/dashboard/device-summary

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/device-

summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 455

Fortinet Inc.
Get /user/dashboard/device-summary

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"tag": "string",
"onlineIcon": "string",
"offlineIcon": "string",
"onlineCount": 0,
"offlineCount": 0
}
]
}

FortiNAC F 7.4.0 REST API 456

Fortinet Inc.
Post /user/dashboard/device-summary/device/{tag}/{status}

Post /user/dashboard/device-summary/device/{tag}/
{status}

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Parameters

Name Required Type

tag Yes String

status Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard/device-

summary/device/1/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 457

Fortinet Inc.
Post /user/dashboard/device-summary/device/{tag}/{status}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"deviceID": 0,
"objectID": 0,
"deviceName": "string",
"description": "string",
"type": "string"
}
]
}

FortiNAC F 7.4.0 REST API 458

Fortinet Inc.
Get /user/dashboard/device-summary/port/offline

Get /user/dashboard/device-summary/port/offline

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/device-

summary/port/offline

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 459

Fortinet Inc.
Get /user/dashboard/device-summary/port/offline

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"deviceID": 0,
"objectID": 0,
"deviceName": "string",
"description": "string",
"type": "string"
}
]
}

FortiNAC F 7.4.0 REST API 460

Fortinet Inc.
Get /user/dashboard/device-summary/port/online

Get /user/dashboard/device-summary/port/online

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/device-

summary/port/online

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 461

Fortinet Inc.
Get /user/dashboard/device-summary/port/online

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"deviceID": 0,
"objectID": 0,
"deviceName": "string",
"description": "string",
"type": "string"
}
]
}

FortiNAC F 7.4.0 REST API 462

Fortinet Inc.
Get /user/dashboard/{id}/usage

Get /user/dashboard/{id}/usage

Description

Returns a list of records that reference this User Dashboard record.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 463

Fortinet Inc.
Get /user/dashboard/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 464

Fortinet Inc.
Get /user/dashboard/scan-summary/per-day

Get /user/dashboard/scan-summary/per-day

Description

Returns a summary of the number of scans per hour over a date range, grouped by the start of the hour.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Yes Integer

endDate Yes Integer

type Optional Integer

platform Optional String

scan Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/scan-

summary/per-day

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 465

Fortinet Inc.
Get /user/dashboard/scan-summary/per-day

Request Body startDate: xxxxxxxxx

endDate: xxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"date": "2024-04-16T23:15:45.226Z",
"passed": 0,
"failed": 0,
"scriptFailed": 0,
"warning": 0
}
]
}

FortiNAC F 7.4.0 REST API 466

Fortinet Inc.
Get /user/dashboard/scan-summary/per-hour

Get /user/dashboard/scan-summary/per-hour

Description

Returns a summary of the number of scans per hour over a date range, grouped by the start of the hour.

Request Headers

Key Value20 Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Yes Integer

endDate Yes Integer

type Optional Integer

platform Optional String

scan Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboardscan-

summary/per-day

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 467

Fortinet Inc.
Get /user/dashboard/scan-summary/per-hour

Request Body startDate: xxxxxxxxx

endDate: xxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"date": "2024-04-16T23:15:45.226Z",
"passed": 0,
"failed": 0,
"scriptFailed": 0,
"warning": 0
}
]
}

FortiNAC F 7.4.0 REST API 468

Fortinet Inc.
Get /user/dashboard/host-summary

Get /user/dashboard/host-summary

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/host-

summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 469

Fortinet Inc.
Get /user/dashboard/host-summary

Sample Response

{
"status": "Success",
"errorMessage": null,
"allRegistered": null,
"safeAndAuthenticated": null,
"atRisk": null,
"pendingAtRisk": null,
"notAuthenticated": null,
"atRiskAndNotAuthenticated": null,
"pendingAtRiskAndNotAuthenticated": null,
"unregistered": null,
"ipPhone": null,
"allHosts": null
}

FortiNAC F 7.4.0 REST API 470

Fortinet Inc.
Get /user/dashboard/user-summary

Get /user/dashboard/user-summary

Description

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/user-

summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 471

Fortinet Inc.
Get /user/dashboard/user-summary

Sample Response

{
"status": "success",
"errorMessage": null,
"totalUsers": 1,
"enabledUsers": 1,
"disabledUsers": 0,
"totalGuests": 0,
"enabledGuests": 0,
"disabledGuests": 0
}

FortiNAC F 7.4.0 REST API 472

Fortinet Inc.
Get /user/dashboard

Get /user/dashboard

Description

Returns a list of User Dashboard records matching the supplied filter owned by the currently logged on user.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 473

Fortinet Inc.
Get /user/dashboard

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"canDelete": true,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:39:59.597Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 474

Fortinet Inc.
Get /user/dashboard

FortiNAC F 7.4.0 REST API 475

Fortinet Inc.
Get /user/dashboard/{id}

Get /user/dashboard/{id}

Description

Returns a list of User Dashboard records matching the supplied filter.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 476

Fortinet Inc.
Get /user/dashboard/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"canDelete": true,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:39:59.597Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 477

Fortinet Inc.
Get /user/dashboard/{id}

FortiNAC F 7.4.0 REST API 478

Fortinet Inc.
Post /user/dashboard/delete

Post /user/dashboard/delete

Description

Deletes a list of User Dashboard records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array[String]

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 479

Fortinet Inc.
Post /user/dashboard/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 480

Fortinet Inc.
Post /user/dashboard/{id}/delete

Post /user/dashboard/{id}/delete

Description

Deletes a single User Dashboard record by ID.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 481

Fortinet Inc.
Post /user/dashboard/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 482

Fortinet Inc.
Post /user/dashboard/{id}/resetToDefault

Post /user/dashboard/{id}/resetToDefault

Description

Resets the Dashboard Tiles to default if the currently logged on user owns that dashboard.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/dashboard/1/resetToDefault

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 483

Fortinet Inc.
Post /user/dashboard/{id}/resetToDefault

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 484

Fortinet Inc.
Post /user/dashboard

Post /user/dashboard

Description

Creates a new user Dashboard record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",

FortiNAC F 7.4.0 REST API 485

Fortinet Inc.
Post /user/dashboard

"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:52:36.273Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 486

Fortinet Inc.
Post /user/dashboard/{id}

Post /user/dashboard/{id}

Description

Updates a User Dashboard record.

Parameter

ID, DBID of the user dashboard.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",

FortiNAC F 7.4.0 REST API 487

Fortinet Inc.
Post /user/dashboard/{id}

"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:52:36.273Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

FortiNAC F 7.4.0 REST API 488

Fortinet Inc.
Post /user/dashboard/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"canDelete": true,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:39:59.597Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 489

Fortinet Inc.
Post /user/dashboard/{id}

FortiNAC F 7.4.0 REST API 490

Fortinet Inc.
Post /user/dashboard/rank/set

Post /user/dashboard/rank/set

Description

Sets the rank of the supplied user dashboard, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Integer

rank Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/dashboard/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

rank:2

FortiNAC F 7.4.0 REST API 491

Fortinet Inc.
Post /user/dashboard/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 492

Fortinet Inc.
Device Identity

Device Identity

FortiNAC F 7.4.0 REST API 493

Fortinet Inc.
Delete /host/device-identity/{id}

Delete /host/device-identity/{id}

Description

Deletes the Device Identity record supplied, if it is not currently in use.

Request Parameter

ID, DBID of the device identity.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/device-

identity/555

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 494

Fortinet Inc.
Delete /host/device-identity/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 495

Fortinet Inc.
Get /host/device-identity

Get /host/device-identity

Description

Returns all Device Identity record which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-identity

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 496

Fortinet Inc.
Get /host/device-identity

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"source": "DHCPv4",
"physAddress": "00:50:56:B5:EB:29",
"ipAddress": null,
"hostName": "S108DVQRI__QHD91",
"entityTag": "network",
"os": "FortiSwitch",
"createTime": "2023-08-25T17:40:54.000+0000",
"lastHeardTime": "2023-09-
28T19:11:26.000+0000",
"registered": true,
"vendorOUI": "00:50:56",
"vendorName": "VMware, Inc.",
"dpcRuleName": null,
"dpcRuleId": -1,
"entity": {
"name": "Network",
"tag": "network",
"imageFile":
"icons/device/generated/network_
16.png",
"id": 9
}
}
"registered": {
"filtered": 1,
"total": 1
}
}
}

FortiNAC F 7.4.0 REST API 497

Fortinet Inc.
Get /host/device-identity/count

Get /host/device-identity/count

Description

Gets a count of Device Identity records that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-identity/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 498

Fortinet Inc.
Get /host/device-identity/count

Sample Response

FortiNAC F 7.4.0 REST API 499

Fortinet Inc.
Get /host/device-identity/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T17:51:42.087Z",
"lastHeardTime": "2024-04-17T17:51:42.087Z",
"registered": true,
"vendorOUI": "string",
"vendorName": "string",
"dpcRuleName": "string",
"dpcRuleId": 0,
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}
],
"filtered": 0,
"total": 0,
"totals": {
"entityTag": [
{
"name": "string",
"count": 0
}
],
"os": [
{
"name": "string",
"count": 0
}
],
"source": [
{
"name": "string",
"count": 0
}
],
"vendorName": [
{
"name": "string",
"count": 0
}
],
"vendorOUI": [
{
"name": "string",
"count": 0
}
],
FortiNAC F"rogues":
7.4.0 REST{API 500
Fortinet Inc. "filtered": 0,
"total": 0
},
Get /host/device-identity/count

FortiNAC F 7.4.0 REST API 501

Fortinet Inc.
Get /host/device-identity/count/all

Get /host/device-identity/count/all

Description

Returns the count of all Device identity records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-

identity/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 502

Fortinet Inc.
Get /host/device-identity/count/all

Sample Response

FortiNAC F 7.4.0 REST API 503

Fortinet Inc.
Get /host/device-identity/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T17:51:42.087Z",
"lastHeardTime": "2024-04-17T17:51:42.087Z",
"registered": true,
"vendorOUI": "string",
"vendorName": "string",
"dpcRuleName": "string",
"dpcRuleId": 0,
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}
],
"filtered": 0,
"total": 0,
"totals": {
"entityTag": [
{
"name": "string",
"count": 0
}
],
"os": [
{
"name": "string",
"count": 0
}
],
"source": [
{
"name": "string",
"count": 0
}
],
"vendorName": [
{
"name": "string",
"count": 0
}
],
"vendorOUI": [
{
"name": "string",
"count": 0
}
],
FortiNAC F"rogues":
7.4.0 REST{API 504
Fortinet Inc. "filtered": 0,
"total": 0
},
Get /host/device-identity/count/all

FortiNAC F 7.4.0 REST API 505

Fortinet Inc.
Get /host/device-identity/{id}

Get /host/device-identity/{id}

Description

Returns the Device Identity record which match the supplied DBID.

Request Parameter

ID, DBID of the device identity.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-identity/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 506

Fortinet Inc.
Get /host/device-identity/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"source": "DHCPv4",
"physAddress": "00:50:56:B5:EB:29",
"ipAddress": null,
"hostName": "S108DVQRI__QHD91",
"entityTag": "network",
"os": "FortiSwitch",
"createTime": "2023-08-25T17:40:54.000+0000",
"lastHeardTime": "2023-09-
28T19:11:26.000+0000",
"registered": true,
"vendorOUI": "00:50:56",
"vendorName": "VMware, Inc.",
"dpcRuleName": null,
"dpcRuleId": -1,
"entity": {
"name": "Network",
"tag": "network",
"imageFile":
"icons/device/generated/network_
16.png",
"id": 9
}
}
"registered": {
"filtered": 1,
"total": 1
}
}
}

FortiNAC F 7.4.0 REST API 507

Fortinet Inc.
Get /host/device-identity/{id}/usage

Get /host/device-identity/{id}/usage

Description

Returns a list of records that reference this Device Identity record.

Parameter

ID, or DBID of the device identity.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-

identity/9/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 508

Fortinet Inc.
Get /host/device-identity/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 509

Fortinet Inc.
Get /host/device-identity/fingerprints

Get /host/device-identity/fingerprints

Description

Returns the full Fingerprint information, including attributes, for a specified fingerprint.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ids Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-

identity/fingerprints

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ids:1

FortiNAC F 7.4.0 REST API 510

Fortinet Inc.
Get /host/device-identity/fingerprints

Sample Response

{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T18:25:34.456Z",
"lastHeardTime": "2024-04-17T18:25:34.456Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

FortiNAC F 7.4.0 REST API 511

Fortinet Inc.
Get /host/device-identity/fingerprint/{id}

Get /host/device-identity/fingerprint/{id}

Description

Returns the full Fingerprint information, including attributes, for a specified fingerprint.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-

identity/fingerprints

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 512

Fortinet Inc.
Get /host/device-identity/fingerprint/{id}

Sample Response

{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T18:25:34.456Z",
"lastHeardTime": "2024-04-17T18:25:34.456Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

FortiNAC F 7.4.0 REST API 513

Fortinet Inc.
Post /host/device-identity

Post /host/device-identity

Description

Adds a new Device Identity record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 514

Fortinet Inc.
Post /host/device-identity

Request Body {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2023-09-29T21:15:13.496Z",
"lastHeardTime": "2023-09-29T21:15:13.496Z",
"registered": true,
"vendorOUI": "string",
"vendorName": "string",
"dpcRuleName": "string",
"dpcRuleId": 0,
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 515

Fortinet Inc.
Post /host/device-identity/delete

Post /host/device-identity/delete

Description

Deletes the Device Identity record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array<String>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-

identity/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 516

Fortinet Inc.
Post /host/device-identity/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 517

Fortinet Inc.
Post /host/device-identity/{id}

Post /host/device-identity/{id}

Description

Updates an existing Device Identity record in the database.

Request Parameter

ID, DBID of the device identity.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity/555

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 555,
"source": "FortiGuard",
"physAddress": "00:50:56:B5:39:06",
"ipAddress": null,
"hostName": null,
"entityTag": "Server",
"os": "Windows",
"createTime": "2023-09-19T17:16:08.000+0000",

FortiNAC F 7.4.0 REST API 518

Fortinet Inc.
Post /host/device-identity/{id}

"lastHeardTime": "2023-09-19T17:16:08.000+0000",
"registered": false,
"vendorOUI": "00:50:56",
"vendorName": "VMware, Inc.",
"dpcRuleName": null,
"dpcRuleId": -1,
"entity": {
"name": "Server",
"tag": "Server",
"imageFile": "icons/device/generated/server_16.png",
"id": 10
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 519

Fortinet Inc.
Post /host/device-identity/{id}/delete

Post /host/device-identity/{id}/delete

Description

Deletes the Device Identity record supplied, if they are not currently in use.

Parameter

ID, or DBID of the device identity.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-

identity/9/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 520

Fortinet Inc.
Post /host/device-identity/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 521

Fortinet Inc.
Post /host/device-identity/confirm-rule

Post /host/device-identity/confirm-rule

Description

Confirms a rule in Profiled Devices view.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array<String>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-

identity/confirm-rule

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 522

Fortinet Inc.
Post /host/device-identity/confirm-rule

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 523

Fortinet Inc.
Device Identity Source

Device Identity Source

FortiNAC F 7.4.0 REST API 524

Fortinet Inc.
Delete /host/device-identity-source/{id}

Delete /host/device-identity-source/{id}

Description

Deletes a single Device Identity Source record by ID.

Paramter

Id, the Device Identity Source record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/device-identity-

source/10

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 525

Fortinet Inc.
Delete /host/device-identity-source/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 526

Fortinet Inc.
Get /host/device-identity-source

Get /host/device-identity-source

Description

Returns a list of Device Identity Source records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-identity-

source

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 527

Fortinet Inc.
Get /host/device-identity-source

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"rank": 1,
"version": 0,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:25.000+0000",
"name": "Agent",
"enabled": true,
"enableRegistered": true,
"canDelete": false
},
{
"dbid": 2,
"rank": 2,
"version": 0,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:25.000+0000",
"name": "Windows Profile",
"enabled": true,
"enableRegistered": true,
"canDelete": false
}
],
"filtered": 2,
"total": 2
}

FortiNAC F 7.4.0 REST API 528

Fortinet Inc.
Get /host/device-identity-source/{id}

Get /host/device-identity-source/{id}

Description

Returns a list of Device Identity Source records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Paramter

Id, the Device Identity Source record Id.

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-identity-

source/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 529

Fortinet Inc.
Get /host/device-identity-source/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 3,
"rank": 9,
"version": 0,
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-10-
26T21:32:42.000+0000",
"name": "WinRM",
"enabled": true,
"enableRegistered": true,
"canDelete": false
}
],
"filtered": 1,
"total": 11
}

FortiNAC F 7.4.0 REST API 530

Fortinet Inc.
Post /host/device-identity-source

Post /host/device-identity-source

Description

Creates a new Device Identity Source record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-10-26T21:14:52.301Z",
"name": "string",
"enabled": true,
"enableRegistered": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-10-26T21:14:52.301Z",
"liveObj": {

FortiNAC F 7.4.0 REST API 531

Fortinet Inc.
Post /host/device-identity-source

"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 532

Fortinet Inc.
Post /host/device-identity-source/delete

Post /host/device-identity-source/delete

Description

Deletes a list of Device Identity Source records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:3

FortiNAC F 7.4.0 REST API 533

Fortinet Inc.
Post /host/device-identity-source/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 534

Fortinet Inc.
Post /host/device-identity-source/{id}

Post /host/device-identity-source/{id}

Description

Updates an Device Identity Source record.

Parameter

Id, the Device Identity Source record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 3,
"rank": 9,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-10-26T21:14:52.301Z",
"name": "string",
"enabled": true,
"enableRegistered": true,

FortiNAC F 7.4.0 REST API 535

Fortinet Inc.
Post /host/device-identity-source/{id}

"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-10-26T21:14:52.301Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 536

Fortinet Inc.
Post /host/device-identity-source/{id}/delete

Post /host/device-identity-source/{id}/delete

Description

Deletes a single Device Identity Source record by ID.

Parameter

Id, the Device Identity Source record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/3/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 537

Fortinet Inc.
Post /host/device-identity-source/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 538

Fortinet Inc.
Post /host/device-identity-source/{id}/disable

Post /host/device-identity-source/{id}/disable

Description

Disables the supplied Device Identity Source.

Parameter

Id, the Device Identity Source record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/7/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 539

Fortinet Inc.
Post /host/device-identity-source/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 540

Fortinet Inc.
Post /host/device-identity-source/{id}/enable

Post /host/device-identity-source/{id}/enable

Description

Enables the supplied Device Identity Source.

Parameter

Id, the Device Identity Source record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/7/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 541

Fortinet Inc.
Post /host/device-identity-source/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 542

Fortinet Inc.
Post /host/device-identity-source/rank/set

Post /host/device-identity-source/rank/set

Description

Sets the rank of the supplied Device Identity Source, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:3

rank:9

FortiNAC F 7.4.0 REST API 543

Fortinet Inc.
Post /host/device-identity-source/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 544

Fortinet Inc.
Post /host/device-identity-source/rank/swap

Post /host/device-identity-source/rank/swap

Description

Swaps the rank position of the two supplied Device Identity Source.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-identity-

source/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1:1

id2:3

FortiNAC F 7.4.0 REST API 545

Fortinet Inc.
Post /host/device-identity-source/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 546

Fortinet Inc.
Device Mgmt Api Connector

Device Mgmt Api Connector

FortiNAC F 7.4.0 REST API 547

Fortinet Inc.
Delete /settings/integration/device-mgmt-api/{id}

Delete /settings/integration/device-mgmt-api/{id}

Description

Deletes a single Device Management API record by ID.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 548

Fortinet Inc.
Delete /settings/integration/device-mgmt-api/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 549

Fortinet Inc.
Get /settings/integration/device-mgmt-api

Get /settings/integration/device-mgmt-api

Description

Returns a list of Device Management API records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 550

Fortinet Inc.
Get /settings/integration/device-mgmt-api

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-27T02:14:06.421Z",
"dbid": 0,
"name": "string",
"apiType": "string",
"apiVersion": "string",
"baseUrl": "string",
"tennantID": "string",
"clientID": "string",
"pollInterval": 0,
"lastPoll": "2024-02-27T02:14:06.421Z",
"lastSuccessfulPoll": "2024-02-
27T02:14:06.421Z",
"createDate": "2024-02-27T02:14:06.421Z",
"authType": "string",
"accessToken": "string",
"refreshToken": "string",
"debug": true,
"connectTimeout": 0,
"readTimeout": 0,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-27T02:14:06.421Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"enabled": true,
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 551

Fortinet Inc.
Get /settings/integration/device-mgmt-api

FortiNAC F 7.4.0 REST API 552

Fortinet Inc.
Get /settings/integration/device-mgmt-api/{id}

Get /settings/integration/device-mgmt-api/{id}

Description

Returns a list of Device Management API records matching the supplied filter.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 553

Fortinet Inc.
Get /settings/integration/device-mgmt-api/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-27T02:14:06.421Z",
"dbid": 0,
"name": "string",
"apiType": "string",
"apiVersion": "string",
"baseUrl": "string",
"tennantID": "string",
"clientID": "string",
"pollInterval": 0,
"lastPoll": "2024-02-27T02:14:06.421Z",
"lastSuccessfulPoll": "2024-02-
27T02:14:06.421Z",
"createDate": "2024-02-27T02:14:06.421Z",
"authType": "string",
"accessToken": "string",
"refreshToken": "string",
"debug": true,
"connectTimeout": 0,
"readTimeout": 0,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-27T02:14:06.421Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"enabled": true,
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 554

Fortinet Inc.
Get /settings/integration/device-mgmt-api/{id}

FortiNAC F 7.4.0 REST API 555

Fortinet Inc.
Get /settings/integration/device-mgmt-api/{id}/usage

Get /settings/integration/device-mgmt-api/{id}/usage

Description

Returns a list of records that reference this Device Management API record.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 556

Fortinet Inc.
Get /settings/integration/device-mgmt-api/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 557

Fortinet Inc.
Post /settings/integration/device-mgmt-api

Post /settings/integration/device-mgmt-api

Description

Creates a new Device Management API record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"apiType": "string",
"apiVersion": "string",
"baseUrl": "string",
"tennantID": "string",
"clientID": "string",
"password": "string",
"pollInterval": 0,
"lastPoll": "2024-02-27T02:18:39.202Z",
"lastSuccessfulPoll": "2024-02-27T02:18:39.202Z",
"createDate": "2024-02-27T02:18:39.202Z",
"authType": "string",
"accessToken": "string",

FortiNAC F 7.4.0 REST API 558

Fortinet Inc.
Post /settings/integration/device-mgmt-api

"refreshToken": "string",
"debug": true,
"connectTimeout": 0,
"readTimeout": 0,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-27T02:18:39.202Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"enabled": true,
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 559

Fortinet Inc.
Post /settings/integration/device-mgmt-api/delete

Post /settings/integration/device-mgmt-api/delete

Description

Deletes a list of Device Management API record supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ids Yes Array[String]

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ids:6

FortiNAC F 7.4.0 REST API 560

Fortinet Inc.
Post /settings/integration/device-mgmt-api/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 561

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}

Post /settings/integration/device-mgmt-api/{id}

Description

Updates an Device Management API record, creating it if no record is found with that DBID.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"apiType": "string",
"apiVersion": "string",
"baseUrl": "string",
"tennantID": "string",
"clientID": "string",
"password": "string",

FortiNAC F 7.4.0 REST API 562

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}

"pollInterval": 0,
"lastPoll": "2024-02-27T02:18:39.202Z",
"lastSuccessfulPoll": "2024-02-27T02:18:39.202Z",
"createDate": "2024-02-27T02:18:39.202Z",
"authType": "string",
"accessToken": "string",
"refreshToken": "string",
"debug": true,
"connectTimeout": 0,
"readTimeout": 0,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-27T02:18:39.202Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"enabled": true,
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 563

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 564

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}/test

Post /settings/integration/device-mgmt-api/{id}/test

Description

Tests connection with the Management API server, but does not update or synchornize.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/1/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 565

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}/test

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 566

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}/poll

Post /settings/integration/device-mgmt-api/{id}/poll

Description

Polls and resynchronizes with an Management API service.

Request Parameter

Id, the Device Management API Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/device-mgmt-

api/1/poll

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 567

Fortinet Inc.
Post /settings/integration/device-mgmt-api/{id}/poll

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 568

Fortinet Inc.
Device Profiler

Device Profiler

FortiNAC F 7.4.0 REST API 569

Fortinet Inc.
Get /DeviceProfiler/Rule/export

Get /DeviceProfiler/Rule/export

Description

Exports the configured Device Profiler rules as a download.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/DeviceProfiler/Rule/export

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 570

Fortinet Inc.
Get /DeviceProfiler/Rule/export

Sample Response

FortiNAC F 7.4.0 REST API 571

Fortinet Inc.
Get /DeviceProfiler/Rule/export

{
"rules": [
{
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
"disable": true,
"version": 0
FortiNAC F 7.4.0
}, REST API 572
Fortinet Inc. "lastModifiedBy": "string",
"lastModifiedDate": "2024-04-17T21:01:24.772Z",
"guid": 0,
Get /DeviceProfiler/Rule/export

FortiNAC F 7.4.0 REST API 573

Fortinet Inc.
Get /settings/device/device-profiler

Get /settings/device/device-profiler

Description

Returns the currently configured Device Profiler settings.

Request Headers

Key Value Type Description

Authorization Bearer <Authorization Token> String Authorization credential generated by

FortiNAC

Content-Type application/json String

(option 1)

Content-Type application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/device-

profiler

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 574

Fortinet Inc.
Get /settings/device/device-profiler

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"createRogues": "true",
"disablePing": "false",
"collectUrl":
"https://globaldevcollect.fortinet.net/v1/iotr
eports",
"queryUrl":
"https://globaldevquery.fortinet.net/fgdsvc",
"isUsg": false,
"passiveIotEnabled": "true",
"passiveNmapEnabled": "false",
"collectEnabled": "true"
}
}

FortiNAC F 7.4.0 REST API 575

Fortinet Inc.
Post /settings/device/device-profiler

Post /settings/device/device-profiler

Description

Adds a new device profiler configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

createRogues Required String

disablePing Required String

collectEnabled Required String

collectUrl Required String

queryUrl Required String

isUsg Required Boolean

passivelotEnabled Required String

passiveNmapEnabled Required String

FortiNAC F 7.4.0 REST API 576

Fortinet Inc.
Post /settings/device/device-profiler

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-

profiler

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body createRogues : xxxxx

disablePing: xxxxx
collectEnabled: xxxxx
collectUrl: xxxxx
queryUrl: xxxxxxxxxxxxx
isUsg: false
passivelotEnabled: xxxxxxxxxx
passiveNmapEnabled: xxxxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"createRogues": "string",
"disablePing": "string",
"enabled": "string",
"collectUrl": "string",
"queryUrl": "string",
"isUsg": true,
"passiveIotEnabled": "string",
"passiveNmapEnabled": "string",
"collectEnabled": "string"
}
}

FortiNAC F 7.4.0 REST API 577

Fortinet Inc.
Directory Agent Config

Directory Agent Config

FortiNAC F 7.4.0 REST API 578

Fortinet Inc.
Delete /settings/agent/directory-agent/{id}

Delete /settings/agent/directory-agent/{id}

Description

Deletes a single Directory Agent Configuration record by ID.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELET https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 579

Fortinet Inc.
Delete /settings/agent/directory-agent/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 580

Fortinet Inc.
Get /settings/agent/directory-agent

Get /settings/agent/directory-agent

Description

Returns a list of Device Identity Source records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/directory-agent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 581

Fortinet Inc.
Get /settings/agent/directory-agent

Sample Response

FortiNAC F 7.4.0 REST API 582

Fortinet Inc.
Get /settings/agent/directory-agent

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-17T21:08:26.604Z",
"name": "string",
"registerRogue": true,
"registerByUser": true,
"appliedGroupName": "string",
"policyName": "string",
"scanGraceLength": 0,
"enabled": true,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-17T21:08:26.604Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addGroupListCopy": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"
}
],
"addToGroupIDs": [
0
],
"addToGroupNames": [
"string"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 583

Fortinet Inc.
Get /settings/agent/directory-agent/directory-groups

Get /settings/agent/directory-agent/directory-groups

Description

Returns all Device Groups for use when creating Directory Agent Configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/directory-groups

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 584

Fortinet Inc.
Get /settings/agent/directory-agent/directory-groups

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 585

Fortinet Inc.
Get /settings/agent/directory-agent/groups

Get /settings/agent/directory-agent/groups

Description

Returns all Device Groups for use when creating Directory Agent Configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/groups

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 586

Fortinet Inc.
Get /settings/agent/directory-agent/groups

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "<Group Name>",
"id": 29
},
{
"name": "Vulnerability Scanner Exceptions",
"id": 17
}
]
}

FortiNAC F 7.4.0 REST API 587

Fortinet Inc.
Get /settings/agent/directory-agent/{id}

Get /settings/agent/directory-agent/{id}

Description

Returns a list of Directory Agent Configuration records matching the supplied filter.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 588

Fortinet Inc.
Get /settings/agent/directory-agent/{id}

Sample Response

FortiNAC F 7.4.0 REST API 589

Fortinet Inc.
Get /settings/agent/directory-agent/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-10-27T18:51:22.158Z",
"name": "string",
"registerRogue": true,
"registerByUser": true,
"appliedGroupName": "string",
"policyName": "string",
"scanGraceLength": 0,
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-10-27T18:51:22.158Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"addGroupListCopy": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"
}
],
"addToGroupIDs": [
0
],
"addToGroupNames": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 590

Fortinet Inc.
Get /settings/agent/directory-agent/{id}

FortiNAC F 7.4.0 REST API 591

Fortinet Inc.
Get /settings/agent/directory-agent/{id}/usage

Get /settings/agent/directory-agent/{id}/usage

Description

Returns a list of records that reference this Directory Agent Configuration record.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 592

Fortinet Inc.
Get /settings/agent/directory-agent/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 593

Fortinet Inc.
Get /settings/agent/directory-agent/subnet

Get /settings/agent/directory-agent/subnet

Description

Returns all IP ranges currently configured for Directory Agent Configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/subnet

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 594

Fortinet Inc.
Get /settings/agent/directory-agent/subnet

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 595

Fortinet Inc.
Get /settings/agent/directory-agent/subnet/test

Get /settings/agent/directory-agent/subnet/test

Description

Test if the supplied IP address exists in any configured IP ranges.

Parameters

IP of the configured IP ranges.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/subnet/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Parameter ip:xx.xx.xx.xxx

FortiNAC F 7.4.0 REST API 596

Fortinet Inc.
Get /settings/agent/directory-agent/subnet/test

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 597

Fortinet Inc.
Post /settings/agent/directory-agent

Post /settings/agent/directory-agent

Description

Creates a new Directory Agent Configurations records, updating instead if the supplied profile has a DBID of one that
already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-agent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-10-27T18:28:50.084Z",
"name": "string",
"registerRogue": true,
"registerByUser": true,
"appliedGroupName": "string",
"addGroupList": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"

FortiNAC F 7.4.0 REST API 598

Fortinet Inc.
Post /settings/agent/directory-agent

}
],
"policyName": "string",
"scanGraceLength": 0,
"enabled": true,
"debug": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-10-27T18:28:50.084Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"addGroupListCopy": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"
}
],
"addToGroupIDs": [
0
],
"addToGroupNames": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 599

Fortinet Inc.
Post /settings/agent/directory-agent

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 600

Fortinet Inc.
Post /settings/agent/directory-agent/delete

Post /settings/agent/directory-agent/delete

Description

Deletes a list of Directory Agent Configuration records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 601

Fortinet Inc.
Post /settings/agent/directory-agent/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 602

Fortinet Inc.
Post /settings/agent/directory-agent/{id}

Post /settings/agent/directory-agent/{id}

Description

Updates an Directory Agent Configurations record.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/7

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-10-27T18:28:50.084Z",
"name": "string",
"registerRogue": true,
"registerByUser": true,

FortiNAC F 7.4.0 REST API 603

Fortinet Inc.
Post /settings/agent/directory-agent/{id}

"appliedGroupName": "string",
"addGroupList": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"
}
],
"policyName": "string",
"scanGraceLength": 0,
"enabled": true,
"debug": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-10-27T18:28:50.084Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"addGroupListCopy": [
{
"directoryAgentGroupListItemID": 0,
"addGroupID": 0,
"addGroupName": "string",
"config": "string"
}
],
"addToGroupIDs": [
0
],
"addToGroupNames": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 604

Fortinet Inc.
Post /settings/agent/directory-agent/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 605

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/delete

Post /settings/agent/directory-agent/{id}/delete

Description

Deletes a single Directory Agent Configuration record by ID.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/7/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 606

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 607

Fortinet Inc.
Post /settings/agent/directory-agent/subnet

Post /settings/agent/directory-agent/subnet

Description

Adds a new IP range of subnet to allow the Directory agent configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startIP Yes string

endIP Yes string

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/subnet

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 608

Fortinet Inc.
Post /settings/agent/directory-agent/subnet

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 609

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/disable

Post /settings/agent/directory-agent/{id}/disable

Description

Disables the supplied Directory Agent Configuration.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/7/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 610

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 611

Fortinet Inc.
Post /settings/agent/directory-agent/test

Post /settings/agent/directory-agent/test

Description

Tests the Directory Agent Configurations using the supplied Username and Domain name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

usrname Yes string

domain Yes string

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body username: xxxxxxxxx

domain: xxxxxxxxx

FortiNAC F 7.4.0 REST API 612

Fortinet Inc.
Post /settings/agent/directory-agent/test

Sample Response

{
"status": "success",
"errorMessage": null
"results": []
}

FortiNAC F 7.4.0 REST API 613

Fortinet Inc.
Post /settings/agent/directory-agent/rank/swap

Post /settings/agent/directory-agent/rank/swap

Description

Swaps the rank position of the two supplied Directory Agent Configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 1

id2: 3

FortiNAC F 7.4.0 REST API 614

Fortinet Inc.
Post /settings/agent/directory-agent/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 615

Fortinet Inc.
Post /settings/agent/directory-agent/subnet/delete

Post /settings/agent/directory-agent/subnet/delete

Description

Deletes the subnet or subnets from the set of configured IP ranges.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startString Yes string

endString Yes string

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/subnet/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body [
{
"startString": "string",
"endString": "string"

FortiNAC F 7.4.0 REST API 616

Fortinet Inc.
Post /settings/agent/directory-agent/subnet/delete

}
]

Sample Response

{
"status": "success",
"errorMessage": null
"results": []
}

FortiNAC F 7.4.0 REST API 617

Fortinet Inc.
Post /settings/agent/directory-agent/rank/set

Post /settings/agent/directory-agent/rank/set

Description

Sets the rank of the supplied Directory Agent Configuration, shifting other rank as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

rank: 3

FortiNAC F 7.4.0 REST API 618

Fortinet Inc.
Post /settings/agent/directory-agent/rank/set

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 619

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/enable

Post /settings/agent/directory-agent/{id}/enable

Description

Enables the supplied Directory Agent Configuration.

Parameters

Id of the Directory Agent Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/directory-

agent/7/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 620

Fortinet Inc.
Post /settings/agent/directory-agent/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 621

Fortinet Inc.
Discovery

Discovery

FortiNAC F 7.4.0 REST API 622

Fortinet Inc.
Get /device/discovery/discover/status/all

Get /device/discovery/discover/status/all

Description

Returns the percentage complete for all discoveries across all containers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/device/discovery/discover/status/all

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 623

Fortinet Inc.
Get /device/discovery/discover/status/all

Sample Response

{
"status": "success",
"errorMessage": null,
"results": null
}

FortiNAC F 7.4.0 REST API 624

Fortinet Inc.
Get /device/discovery/discover/status

Get /device/discovery/discover/status

Description

Returns the discovery status for a single container.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

containerName Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/discovery/discover/status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body containerName: xxxxxxxx

FortiNAC F 7.4.0 REST API 625

Fortinet Inc.
Get /device/discovery/discover/status

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"currentAddress": "string",
"devicesFound": 0,
"useCDP": true,
"deviceTotal": 0,
"totalAddresses": 0,
"devicesProcessed": 0,
"snmpV1Errors": [
"string"
],
"snmpV3Errors": [
"string"
],
"cliErrors": [
"string"
],
"vendorOIDMismatch": [
"string"
],
"pingFailures": [
"string"
],
"ipList": [
{}
],
"seedList": [
"string"
],
"endTime": "2024-04-17T21:52:18.095Z",
"startingAddress": "string",
"endingAddress": "string"
}
}

FortiNAC F 7.4.0 REST API 626

Fortinet Inc.
Post /device/discovery/discover/stop

Post /device/discovery/discover/stop

Description

Stops the discovery on a single container.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

containerName Yes string The name of the container.

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/discovery/discover/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body containerName: xxxxxxxxxxx

FortiNAC F 7.4.0 REST API 627

Fortinet Inc.
Post /device/discovery/discover/stop

Sample Response

{
"status": "success",
"errorMessage": null,
"results": false
}

FortiNAC F 7.4.0 REST API 628

Fortinet Inc.
Post /device/discovery/discover

Post /device/discovery/discover

Description

Starts a discovery for one of more IP ranges or seeds into adding discovered devices to the specified container.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/discovery/discover

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body [
{
"container": "string",
"useCDP": true,
"ipRanges": [
[
"string"
]
],
"cdpSeeds": [
"string"
],
"snmpSecurityStrings": [
"string"
],
"snmpV3Credentials": [
{

FortiNAC F 7.4.0 REST API 629

Fortinet Inc.
Post /device/discovery/discover

"version": 0,
"userName": "string",
"userPassword": "string",
"userPrivacyPassword": "string",
"authenticationProtocol": 0,
"privacyProtocol": 0,
"snmpVersion": 0,
"community": "string",
"authenticationProtocolAsString": "string",
"authenticationProtocolAsOID": {
"value": [
0
],
"syntax": 0,
"valid": true,
"berlength": 0,
"exception": true,
"dynamic": true,
"berpayloadLength": 0,
"syntaxString": "string"
},
"privacyProtocolAsString": "string",
"privacyProtocolAsOID": {
"value": [
0
],
"syntax": 0,
"valid": true,
"berlength": 0,
"exception": true,
"dynamic": true,
"berpayloadLength": 0,
"syntaxString": "string"
}
}
],
"cliCredentials": [
{
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
}
]
}
]

FortiNAC F 7.4.0 REST API 630

Fortinet Inc.
Post /device/discovery/discover

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
}

FortiNAC F 7.4.0 REST API 631

Fortinet Inc.
Endpoint Compliance Custom Scan

Endpoint Compliance Custom Scan

FortiNAC F 7.4.0 REST API 632

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan/html

Get /policy/endpoint-compliance/custom-scan/html

Description

Returns the HTML content of a custom scan for the supplied OS, Scan Type, and Scan Name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type Description

os Yes String The supplied operating system.

type Yes String The scan type.

scanName Yes String The scan name.

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/custom-scan/html

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body os: xxxxxxxx

type: xxxxxxxx
scanName: xxxxxxxx

FortiNAC F 7.4.0 REST API 633

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan/html

Sample Response

{
"status": "string",
"errorMessage": "string",
"html": "string",
"script": "string"
}

FortiNAC F 7.4.0 REST API 634

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan

Get /policy/endpoint-compliance/custom-scan

Description

Returns all Custom Scans currently stored in the filesystem.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/custom-scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 635

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan

Sample Response

{
"status": "success",
"errorMessage": null,
"osList": [
"Windows",
"Mac-OS-X",
"Linux"
],
"scans": {
"Linux": [],
"Windows": [],
"Mac-OS-X": []
},
"scanTypeHash": {
"Linux": [
"File",
"Package",
"Processes",
"Prohibited-Processes",
"Script"
],
"Windows": [
"Cert-Check",
"Domain-Check",
"Domain-Verification",
"File",
"HotFixes",
"Processes",
"Prohibited-Domain-Verification",
"Prohibited-Processes",
"Registry-Keys",
"Registry-Version",
"Service"
],
"Mac-OS-X": [
"File",
"Package",
"Processes",
"Prohibited-Processes"
]
}
}

FortiNAC F 7.4.0 REST API 636

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan/usage

Get /policy/endpoint-compliance/custom-scan/usage

Description

Returns a list of records that reference this Custom Scan record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

os Yes String

scanType Yes String

scanName Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/custom-scan/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body os: xxxxxxxx

type: xxxxxxxx
scanName: xxxxxxxx

FortiNAC F 7.4.0 REST API 637

Fortinet Inc.
Get /policy/endpoint-compliance/custom-scan/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": null
}

FortiNAC F 7.4.0 REST API 638

Fortinet Inc.
Post /policy/endpoint-compliance/custom-scan/custom-scan

Post /policy/endpoint-compliance/custom-scan/custom-
scan

Description

Adds a new Custom Scan for the supplied OS of the supplied type.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

osName Yes String

csType Yes String

scanName Yes String

formData Yes String

isModify Yes boolean

modify Yes boolean

global Yes boolean

FortiNAC F 7.4.0 REST API 639

Fortinet Inc.
Post /policy/endpoint-compliance/custom-scan/custom-scan

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/custom-scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body osName: xxxxxxxx

csType: xxxxxxxx
scanName: xxxxxxxx
formData: xxxxxxxx
isModify: xxxxxxxx
modify: xxxxxxxx
global: xxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 640

Fortinet Inc.
Post /policy/endpoint-compliance/custom-scan/custom-scan/delete

Post /policy/endpoint-compliance/custom-scan/custom-
scan/delete

Description

Deletes a custom scan uniquely identified by its combination of OS, scan type, and scan name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

os Yes String

scanType Yes String

scanName Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/custom-scan/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 641

Fortinet Inc.
Post /policy/endpoint-compliance/custom-scan/custom-scan/delete

Request Body os: xxxxxxxx

scanType: xxxxxxxx
scanName: xxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 642

Fortinet Inc.
Event Action

Event Action

FortiNAC F 7.4.0 REST API 643

Fortinet Inc.
Get /policy/event-action

Get /policy/event-action

Description

Returns a list of Event Action records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/event-action

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 644

Fortinet Inc.
Get /policy/event-action

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 645

Fortinet Inc.
Get /policy/event-action/{id}/usage

Get /policy/event-action/{id}/usage

Description

Returns a list of records that reference this Event Action record.

Request Parameter

Id, Id of the event action.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/event-

action/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 646

Fortinet Inc.
Get /policy/event-action/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 647

Fortinet Inc.
Get /policy/event-action/supporting-info

Get /policy/event-action/supporting-info

Description

Returns the additional information needed to create a Security Rule.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/event-

action/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 648

Fortinet Inc.
Get /policy/event-action/supporting-info

Sample Response

{
"status": "success",
"errorMessage": null,
"scans": [
"SSID-Check-Violation",
"Multihome-Detected",
"Guest No Access",
"SSID-Check-Violation",
"Multihome-Detected",
"Guest No Access"
],
"roles": [
{
"name": "<angle name>",
"id": 7
},
{
"name": "Contractor",
"id": 4
},
],
"cliScripts": [
"RunSharedReports",
"ServiceNow.example"
]
}

FortiNAC F 7.4.0 REST API 649

Fortinet Inc.
Get /policy/event-action/{id}

Get /policy/event-action/{id}

Description

Returns a list of Event Action records matching the supplied filter.

Parameter

Id, Id of the event action.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/event-action/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 650

Fortinet Inc.
Get /policy/event-action/{id}

Sample Response

FortiNAC F 7.4.0 REST API 651

Fortinet Inc.
Get /policy/event-action/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-17T22:13:56.405Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-04-
17T22:13:56.405Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-17T22:13:56.405Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-17T22:13:56.405Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
FortiNAC F 7.4.0 "mysqlTableName":
REST API "string", 652
Fortinet Inc. "idnameQuery": "string"
}
}
Get /policy/event-action/{id}

FortiNAC F 7.4.0 REST API 653

Fortinet Inc.
Post /policy/event-action

Post /policy/event-action

Description

Creates a new Event Action record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/event-action

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2023-11-01T22:31:29.698Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"

FortiNAC F 7.4.0 REST API 654

Fortinet Inc.
Post /policy/event-action

},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-01T22:31:29.698Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-01T22:31:29.698Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 655

Fortinet Inc.
Post /policy/event-action

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 656

Fortinet Inc.
Post /policy/event-action/delete

Post /policy/event-action/delete

Description

Deletes a list of Event Action records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/event-

action/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:5

FortiNAC F 7.4.0 REST API 657

Fortinet Inc.
Post /policy/event-action/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 658

Fortinet Inc.
Post /policy/event-action/{id}/delete

Post /policy/event-action/{id}/delete

Description

Deletes a single Event Action record by ID.

Parameter

Id, Id of the event action.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/event-

action/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 659

Fortinet Inc.
Post /policy/event-action/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 660

Fortinet Inc.
Post /policy/event-action/{id}

Post /policy/event-action/{id}

Description

Updates an Event Action record.

Parameter

Id, Id of the event action.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/event-action/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2023-11-01T22:31:29.698Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{

FortiNAC F 7.4.0 REST API 661

Fortinet Inc.
Post /policy/event-action/{id}

"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-01T22:31:29.698Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-01T22:31:29.698Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 662

Fortinet Inc.
Post /policy/event-action/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 663

Fortinet Inc.
Delete /policy/event-action/{id}

Delete /policy/event-action/{id}

Description

Deletes a single Event Action record by ID.

Parameter

Id, Id of the event action.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/event-action/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 664

Fortinet Inc.
Delete /policy/event-action/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 665

Fortinet Inc.
FingerPrint

FingerPrint

FortiNAC F 7.4.0 REST API 666

Fortinet Inc.
Get /host/fingerprint

Get /host/fingerprint

Description

Returns a list of Fingerprint records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/fingerprint

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 667

Fortinet Inc.
Get /host/fingerprint

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 3,
"source": "FortiGuard",
"physAddress": "00:50:56:B5:EB:33",
"ipAddress": null,
"hostName": null,
"entityTag": "network",
"os": "Windows",
"createTime": "2023-08-25T17:40:55.000+0000",
"lastHeardTime": "2023-08-25T17:40:55.000+0000",
"attributes": {
"OS": "Windows",
"MODEL": "FortiSwitch-108D-VM",
"CAT": "Network",
"SUBCAT": "Switch",
"VENDOR": "Fortinet",
"CONFIDENCE": "213"
},
"entity": {
"name": "Network",
"tag": "network",
"imageFile": "icons/device/generated/network_
16.png",
"id": 9
}
}
],
"filtered": 1,
"total": 287
}

FortiNAC F 7.4.0 REST API 668

Fortinet Inc.
Get /host/fingerprint/count

Get /host/fingerprint/count

Description

Returns the count of all Fingerprint records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameter

Name Required Type

filter Optional Array <String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/fingerprint/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 669

Fortinet Inc.
Get /host/fingerprint/count

Sample Response

{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T22:32:16.182Z",
"lastHeardTime": "2024-04-17T22:32:16.182Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

FortiNAC F 7.4.0 REST API 670

Fortinet Inc.
Get /host/fingerprint/count/all

Get /host/fingerprint/count/all

Description

Returns the count of all Fingerprint records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/fingerprint/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 671

Fortinet Inc.
Get /host/fingerprint/count/all

Sample Response

{
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-04-17T22:32:16.182Z",
"lastHeardTime": "2024-04-17T22:32:16.182Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

FortiNAC F 7.4.0 REST API 672

Fortinet Inc.
Get /host/fingerprint/{id}

Get /host/fingerprint/{id}

Description

Returns a list of Fingerprint records matching the supplied filter.

Request Parameter

Id, the DBID of the Fingerprint record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/fingerprint/1206

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 673

Fortinet Inc.
Get /host/fingerprint/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1206,
"source": "DHCPv4",
"physAddress": "AC:71:2E:9F:1E:2A",
"ipAddress": null,
"hostName": "S148ENTQ22009587",
"entityTag": "network",
"os": "FortiSwitch",
"createTime": "2023-10-20T18:19:41.000+0000",
"lastHeardTime": "2023-11-01T19:00:28.000+0000",
"attributes": {
"OPTIONLIST": "53,57,61,55,12,60",
"PARAMLIST": "1,2,3,6,12,15,28,40,42",
"VENDORCLASS": "FortiSwitch-148E",
"MSGTYPE": "DHCPv4 DISCOVER"
},
"entity": {
"name": "Network",
"tag": "network",
"imageFile": "icons/device/generated/network_
16.png",
"id": 9
}
}
],
"filtered": 1,
"total": 287
}

FortiNAC F 7.4.0 REST API 674

Fortinet Inc.
Post /host/fingerprint/delete

Post /host/fingerprint/delete

Description

Delete a list of Fingerprint records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/host/fingerprint/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1185

FortiNAC F 7.4.0 REST API 675

Fortinet Inc.
Post /host/fingerprint/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 676

Fortinet Inc.
Post /host/fingerprint/{id}/delete

Post /host/fingerprint/{id}/delete

Description

Delete a single Fingerprint record by ID.

Request Parameter

Id, the DBID of the Fingerprint record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/host/fingerprint/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 677

Fortinet Inc.
Post /host/fingerprint/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 678

Fortinet Inc.
Post /host/fingerprint/{id}

Post /host/fingerprint/{id}

Description

Updates an Fingerprint record.

Parameter

Id, the DBID of the Fingerprint record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/fingerprint/1207

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2023-11-02T18:15:18.417Z",

FortiNAC F 7.4.0 REST API 679

Fortinet Inc.
Post /host/fingerprint/{id}

"lastHeardTime": "2023-11-02T18:15:18.417Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 680

Fortinet Inc.
Post /host/fingerprint

Post /host/fingerprint

Description

Creates a new Fingerprint record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/fingerprint

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2023-11-02T18:15:18.417Z",
"lastHeardTime": "2023-11-02T18:15:18.417Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",

FortiNAC F 7.4.0 REST API 681

Fortinet Inc.
Post /host/fingerprint

"tag": "string",
"imageFile": "string",
"id": 0
}
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 682

Fortinet Inc.
Delete /host/fingerprint/{id}

Delete /host/fingerprint/{id}

Description

Deletes a single Fingerprint record by ID.

Parameter

Id, the DBID of the Fingerprint record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/fingerprint/1206

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 683

Fortinet Inc.
Delete /host/fingerprint/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 684

Fortinet Inc.
Firewall Session

Firewall Session

FortiNAC F 7.4.0 REST API 685

Fortinet Inc.
Get /dynamic/dynamic-connection/{id}

Get /dynamic/dynamic-connection/{id}

Description

Returns a list of record matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 686

Fortinet Inc.
Get /dynamic/dynamic-connection/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"firewall": "string",
"source": "string",
"protocol": "string",
"device": "string",
"country": "string",
"countryID": "string",
"hostname": "string",
"srcAddr": "string",
"srcMac": "string",
"srcPort": "string",
"destAddr": "string",
"destMac": "string",
"destPort": "string",
"sentBytes": 0,
"rcvdBytes": 0,
"sentPackets": 0,
"rcvdPackets": 0,
"addedDate": "2024-04-17T22:37:54.461Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-17T22:37:54.461Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 687

Fortinet Inc.
Get /dynamic/dynamic-connection

Get /dynamic/dynamic-connection

Description

Returns a list of record matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/dynamic/dynamic-connection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 688

Fortinet Inc.
Get /dynamic/dynamic-connection

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"firewall": "string",
"source": "string",
"protocol": "string",
"device": "string",
"country": "string",
"countryID": "string",
"hostname": "string",
"srcAddr": "string",
"srcMac": "string",
"srcPort": "string",
"destAddr": "string",
"destMac": "string",
"destPort": "string",
"sentBytes": 0,
"rcvdBytes": 0,
"sentPackets": 0,
"rcvdPackets": 0,
"addedDate": "2024-04-17T22:37:54.461Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-17T22:37:54.461Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 689

Fortinet Inc.
Post /dynamic/dynamic-connection/polling/{id}/run

Post /dynamic/dynamic-connection/polling/{id}/run

Description

Queues a poll for firewall sessions on the supplied device.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/polling/1/run

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 690

Fortinet Inc.
Post /dynamic/dynamic-connection/polling/{id}/run

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 691

Fortinet Inc.
Get /dynamic/dynamic-connection/polling/{id}

Get /dynamic/dynamic-connection/polling/{id}

Description

Returns the firewall session polling status for the supplied device.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/polling/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 692

Fortinet Inc.
Get /dynamic/dynamic-connection/polling/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"enabled": false,
"frequency": 30,
"createRogues": false
}

FortiNAC F 7.4.0 REST API 693

Fortinet Inc.
Get /dynamic/dynamic-connection/host/{id}

Get /dynamic/dynamic-connection/host/{id}

Description

Returns a list of adapter MAC addresses owned by the supplied Host Record.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/host/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 694

Fortinet Inc.
Get /dynamic/dynamic-connection/host/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 695

Fortinet Inc.
Get /dynamic/dynamic-connection/{id}/usage

Get /dynamic/dynamic-connection/{id}/usage

Description

Returns a list of records that reference this record.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 696

Fortinet Inc.
Get /dynamic/dynamic-connection/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 697

Fortinet Inc.
Post /dynamic/dynamic-connection/{id}/delete

Post /dynamic/dynamic-connection/{id}/delete

Description

Deletes a single record by ID.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/2/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 698

Fortinet Inc.
Post /dynamic/dynamic-connection/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 699

Fortinet Inc.
Post /dynamic/dynamic-connection/polling/{id}

Post /dynamic/dynamic-connection/polling/{id}

Description

Updates the firewall session polling configuration for the supplied device.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/polling/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"enabled": true,
"frequency": 0,
"createRogues": true
}

FortiNAC F 7.4.0 REST API 700

Fortinet Inc.
Post /dynamic/dynamic-connection/polling/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 701

Fortinet Inc.
Post /dynamic/dynamic-connection

Post /dynamic/dynamic-connection

Description

Creates a new record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"firewall": "string",
"source": "string",
"protocol": "string",
"device": "string",
"country": "string",
"countryID": "string",
"hostname": "string",
"srcAddr": "string",
"srcMac": "string",
"srcPort": "string",
"destAddr": "string",
"destMac": "string",
"destPort": "string",
"sentBytes": 0,

FortiNAC F 7.4.0 REST API 702

Fortinet Inc.
Post /dynamic/dynamic-connection

"rcvdBytes": 0,
"sentPackets": 0,
"rcvdPackets": 0,
"addedDate": "2023-11-03T18:20:26.495Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-03T18:20:26.495Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 703

Fortinet Inc.
Post /dynamic/dynamic-connection/{id}

Post /dynamic/dynamic-connection/{id}

Description

Updates a record.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"firewall": "string",
"source": "string",
"protocol": "string",
"device": "string",
"country": "string",
"countryID": "string",
"hostname": "string",

FortiNAC F 7.4.0 REST API 704

Fortinet Inc.
Post /dynamic/dynamic-connection/{id}

"srcAddr": "string",
"srcMac": "string",
"srcPort": "string",
"destAddr": "string",
"destMac": "string",
"destPort": "string",
"sentBytes": 0,
"rcvdBytes": 0,
"sentPackets": 0,
"rcvdPackets": 0,
"addedDate": "2023-11-03T18:20:26.495Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-03T18:20:26.495Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 705

Fortinet Inc.
Post /dynamic/dynamic-connection/delete

Post /dynamic/dynamic-connection/delete

Description

Deletes a list of records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:2

FortiNAC F 7.4.0 REST API 706

Fortinet Inc.
Post /dynamic/dynamic-connection/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 707

Fortinet Inc.
Delete /dynamic/dynamic-connection/{id}

Delete /dynamic/dynamic-connection/{id}

Description

Deletes a single record by ID.

Parameter

Id, the DBID of the firewall session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/dynamic/dynamic-

connection/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 708

Fortinet Inc.
Delete /dynamic/dynamic-connection/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 709

Fortinet Inc.
Firewall Tag

Firewall Tag

FortiNAC F 7.4.0 REST API 710

Fortinet Inc.
Get /settings/integration/firewall-tag

Get /settings/integration/firewall-tag

Description

Returns a list of Firewall Tag records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/firewall-tag

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 711

Fortinet Inc.
Get /settings/integration/firewall-tag

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-17T22:52:14.238Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 712

Fortinet Inc.
Get /settings/integration/firewall-tag/{id}

Get /settings/integration/firewall-tag/{id}

Description

Returns a list of Firewall Tag records matching the supplied filter.

Parameter

Id, the DBID of the Firewall Tag.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/firewall-tag/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 713

Fortinet Inc.
Get /settings/integration/firewall-tag/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-03T22:12:18.286Z",
"lastModifiedDateMilliseconds": 0,
"id": 0,
"name": "string",
"categories": [
"string"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 714

Fortinet Inc.
Get /settings/integration/firewall-tag/{id}/usage

Get /settings/integration/firewall-tag/{id}/usage

Description

Returns a list of records that reference this Firewall Tag record.

Parameter

Id, the DBID of the Firewall Tag.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/firewall-

tag/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 715

Fortinet Inc.
Get /settings/integration/firewall-tag/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 716

Fortinet Inc.
Post /settings/integration/firewall-tag/{id}

Post /settings/integration/firewall-tag/{id}

Description

Updates a Firewall Tag record.

Parameter

Id, the DBID of the Firewall Tag.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/firewall-tag/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"lastModifiedDate": "2023-11-03T22:16:25.733Z",
"id": 0,
"name": "string",
"categories": [
"string"
]
}

FortiNAC F 7.4.0 REST API 717

Fortinet Inc.
Post /settings/integration/firewall-tag/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 718

Fortinet Inc.
Post /settings/integration/firewall-tag

Post /settings/integration/firewall-tag

Description

Creates a new Firewall Tag record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/settings/integration/firewall-tag

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"lastModifiedDate": "2023-11-03T22:16:25.733Z",
"id": 0,
"name": "string",
"categories": [
"string"
]
}

FortiNAC F 7.4.0 REST API 719

Fortinet Inc.
Post /settings/integration/firewall-tag

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 720

Fortinet Inc.
Post /settings/integration/firewall-tag/delete

Post /settings/integration/firewall-tag/delete

Description

Deletes a list of Firewall Tag records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/firewall-

tag/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 721

Fortinet Inc.
Post /settings/integration/firewall-tag/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 722

Fortinet Inc.
Post /settings/integration/firewall-tag/{id}/delete

Post /settings/integration/firewall-tag/{id}/delete

Description

Deletes a single Firewall Tag record by ID.

Parameter

Id, the DBID of the Firewall Tag.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/firewall-

tag/2/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 723

Fortinet Inc.
Post /settings/integration/firewall-tag/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 724

Fortinet Inc.
Delete /settings/integration/firewall-tag/{id}

Delete /settings/integration/firewall-tag/{id}

Description

Delete a single Firewall Tag record by ID.

Parameter

Id, the DBID of the Firewall Tag.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/settings/integration/firewall-tag/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 725

Fortinet Inc.
Delete /settings/integration/firewall-tag/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 726

Fortinet Inc.
FortiGate Telemetry

FortiGate Telemetry

FortiNAC F 7.4.0 REST API 727

Fortinet Inc.
Get /settings/security-fabric/{id}/usage

Get /settings/security-fabric/{id}/usage

Description

Returns a list of records that reference this Security Fabric Connection source.

Parameter

Id, Id of the Security Fabric Connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 728

Fortinet Inc.
Get /settings/security-fabric/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 729

Fortinet Inc.
Get /settings/security-fabric

Get /settings/security-fabric

Description

Returns a list of Security Fabric Connection sources matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 730

Fortinet Inc.
Get /settings/security-fabric

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-18T21:34:48.291Z",
"id": 0,
"ip": "string",
"port": 0,
"status": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 731

Fortinet Inc.
Get /settings/security-fabric/{id}

Get /settings/security-fabric/{id}

Description

Returns a list of Security Fabric Connection sources matching the supplied filter.

Parameter

Id, Id of the Security Fabric Connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 732

Fortinet Inc.
Get /settings/security-fabric/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-18T21:34:48.291Z",
"id": 0,
"ip": "string",
"port": 0,
"status": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 733

Fortinet Inc.
Post /settings/security-fabric

Post /settings/security-fabric

Description

Creates a Security Fabric Connection source, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"ip": "string",
"port": 0,
"status": "string"
}

FortiNAC F 7.4.0 REST API 734

Fortinet Inc.
Post /settings/security-fabric

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 735

Fortinet Inc.
Post /settings/security-fabric/delete

Post /settings/security-fabric/delete

Description

Deletes a list of Security Fabric Connection sources supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 736

Fortinet Inc.
Post /settings/security-fabric/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 737

Fortinet Inc.
Post /settings/security-fabric/{id}/delete

Post /settings/security-fabric/{id}/delete

Description

Deletes a single Security Fabric Connection source by ID.

Parameter

Id, Id of the Security Fabric Connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 738

Fortinet Inc.
Post /settings/security-fabric/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 739

Fortinet Inc.
Post /settings/security-fabric/{id}

Post /settings/security-fabric/{id}

Description

Updates a Security Fabric Connection source.

Parameter

Id, the Id of the Security Fabric Connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"ip": "string",
"port": 0,
"status": "string"
}

FortiNAC F 7.4.0 REST API 740

Fortinet Inc.
Post /settings/security-fabric/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 741

Fortinet Inc.
Delete /settings/security-fabric/{id}

Delete /settings/security-fabric/{id}

Description

Deletes a single Security Fabric Connection source by ID.

Parameter

Id, Id of the Security Fabric Connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/settings/security-

fabric/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 742

Fortinet Inc.
Delete /settings/security-fabric/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 743

Fortinet Inc.
FSSO

FSSO

FortiNAC F 7.4.0 REST API 744

Fortinet Inc.
Get /settings/integration/FSSO

Get /settings/integration/FSSO

Description

Returns the currently configured FSSO server settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2settings/integration/fsso

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 745

Fortinet Inc.
Get /settings/integration/FSSO

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"enabled": "",
"port": "8000",
"password": ""
}
}

FortiNAC F 7.4.0 REST API 746

Fortinet Inc.
Get /settings/integration/FSSO/password

Get /settings/integration/FSSO/password

Description

Returns the password for the currently configured FSSO server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2settings/integration/fsso/password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 747

Fortinet Inc.
Get /settings/integration/FSSO/password

Sample Response

{
"status": "success",
"errorMessage": null,
"result": null
}

FortiNAC F 7.4.0 REST API 748

Fortinet Inc.
Post /settings/integration/FSSO

Post /settings/integration/FSSO

Description

Add FSSO settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

enabled Yes String

port Yes String

password Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2settings/integration/fsso

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body enabled: "Yes"

port: 8000
password:"xxxxx"

FortiNAC F 7.4.0 REST API 749

Fortinet Inc.
Post /settings/integration/FSSO

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 750

Fortinet Inc.
Google

Google

FortiNAC F 7.4.0 REST API 751

Fortinet Inc.
Get /settings/integration/google/domains

Get /settings/integration/google/domains

Description

Returns the list of domains configured to work with Google directory.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2settings/integration/google/domains

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 752

Fortinet Inc.
Get /settings/integration/google/domains

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 753

Fortinet Inc.
Get /settings/integration/google/client-id

Get /settings/integration/google/client-id

Description

Returns the configured Google Client ID, Project Number, and API Key.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2settings/integration/google/client-id

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 754

Fortinet Inc.
Get /settings/integration/google/client-id

Sample Response

{
"status": "string",
"errorMessage": "string",
"clientID": "string",
"apiKey": "string",
"projectNumber": "string"
}

FortiNAC F 7.4.0 REST API 755

Fortinet Inc.
Post /settings/integration/google/domains/set

Post /settings/integration/google/domains/set

Description

Sets the configured Google authentication domains to the list supplied, removing any that are not in that list.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

domainName Yes String

Sample Request

Request POST https://10.106.94.152:8443/api/v2settings/integration/google/domains/set

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request domainName: xxxxxxxx

Body

FortiNAC F 7.4.0 REST API 756

Fortinet Inc.
Post /settings/integration/google/domains/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 757

Fortinet Inc.
Post /settings/integration/google/client-id

Post /settings/integration/google/client-id

Description

Sets the Google Client ID, Project Number, and API Key.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

clientID Optional String

senderID Yes String

apiKey Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2settings/integration/google/client-id

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request clientID: xxxxxxx

Body senderID: xxxxxxxxx
apiKey: xxxxxxxxxxx

FortiNAC F 7.4.0 REST API 758

Fortinet Inc.
Post /settings/integration/google/client-id

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 759

Fortinet Inc.
Post /settings/integration/google/domains/{id}

Post /settings/integration/google/domains/{id}

Description

Modifies an existing Google authentication domain.

Parameter

Id, the Google Client ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

domainName Yes String

Sample Request

Request POST https://10.106.94.152:8443/api/v2settings/integration/google/domains/2

URL
Request Authorization: Bearer <Authorization_Token>
Content-Type: application/json

FortiNAC F 7.4.0 REST API 760

Fortinet Inc.
Post /settings/integration/google/domains/{id}

Header
Request domainName: xxxxxxxxxx
Body

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 761

Fortinet Inc.
Post /settings/integration/google/domains/delete

Post /settings/integration/google/domains/delete

Description

Deletes one or more Google authentication domains.

Parameter

Id, the Google Client ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes String

Sample Request

Reques POST https://10.106.94.152:8443/api/v2settings/integration/google/domains/delete

t URL
Reques Authorization: Bearer <Authorization_Token>
Content-Type: application/json

FortiNAC F 7.4.0 REST API 762

Fortinet Inc.
Post /settings/integration/google/domains/delete

t
Header
Reques domainName: xxxxxxxxxx
t Body

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 763

Fortinet Inc.
Post /settings/integration/google/domains

Post /settings/integration/google/domains

Description

Adds a new Google authentication domain

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

domainName Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2settings/integration/google/domains

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request domainName: xxxxxxxxxx

Body

FortiNAC F 7.4.0 REST API 764

Fortinet Inc.
Post /settings/integration/google/domains

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 765

Fortinet Inc.
Guest Account

Guest Account

FortiNAC F 7.4.0 REST API 766

Fortinet Inc.
Get /user/guest/count

Get /user/guest/count

Description

Returns a count of guest account records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 767

Fortinet Inc.
Get /user/guest/count

Sample Response

FortiNAC F 7.4.0 REST API 768

Fortinet Inc.
Get /user/guest/count

{
"status": "string",
"errorMessage": "string",
"conferenceRegistrations": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"results": [
{
"landscape": 0,
"id": 0,
"role": "string",
"policy": "string",
"firstName": "string",
"lastName": "string",
"sponsor": "string",
"visitorType": 0,
"assetTag": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-04-18T21:49:04.659Z",
"validForTime": "2024-04-18T21:49:04.659Z",
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"country": "string",
"reason": "string",
"personVisiting": "string",
"canSendEmail": true,
"canSendSMS": true,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"reauthenticationPeriod": 0,
"accountEnabled": true,
"dataFields": "string",
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
FortiNAC F 7.4.0
}, REST API 769
Fortinet Inc. "terminateAtEndOfDay": true,
"printedNote": "string",
"numConferenceAttendees": 0,
Get /user/guest/count

FortiNAC F 7.4.0 REST API 770

Fortinet Inc.
Get /user/guest

Get /user/guest

Description

Returns all guest account records which match the supplied fitler.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 771

Fortinet Inc.
Get /user/guest

Sample Response

FortiNAC F 7.4.0 REST API 772

Fortinet Inc.
Get /user/guest

{
"status": "success",
"errorMessage": null,
"conferenceRegistrations": {
"[email protected]": 0
},
"results": [
{
"id": 1,
"clientID": -1,
"role": "GuestAccess",
"policy": null,
"firstName": "test",
"lastName": "test",
"sponsor": "admin",
"visitorType": 0,
"assetTag": null,
"email": "[email protected]",
"userID": "[email protected]",
"password": "",
"creationTime": 1699482047000,
"validForTime": 1700726399000,
"address": null,
"city": null,
"mailState": null,
"zipCode": null,
"phone": null,
"country": null,
"reason": null,
"personVisiting": null,
"canSendEmail": false,
"canSendSMS": false,
"aupURL": null,
"aupIP": null,
"successURL": "http://www.google.com",
"successIP": "",
"reauthenticationPeriod": -1,
"accountEnabled": true,
"dataFields": "",
"authType": 0,
"authServer": -1,
"regType": 0,
"weeklySchedule": {
"version": 1.1,
"startTimeOfDay": -1,
"endTimeOfDay": -1,
"daysOfWeek": -1,
"alwaysOn": true,
"validTime": true,
"endTimeOfDayAM": true,
"startTimeOfDayAM": true,
"startTimeOfDayHours": 12,
"endTimeOfDayHours": 12,
"startTimeOfDayMinutes": -1,
"endTimeOfDayMinutes": -1
},
"printedNote": null,
"clientIds": [
5
],
FortiNAC F 7.4.0 REST API
"numConferenceAttendees": -1, 773
Fortinet Inc. "mobileProvider": null,
"mobileNumber": null,
"conferenceName": null,
Get /user/guest

FortiNAC F 7.4.0 REST API 774

Fortinet Inc.
Get /user/guest/conference/registrations/count

Get /user/guest/conference/registrations/count

Description

Returns the number of registered attendees for the conferences which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Reques GET https://10.106.94.152:8443/api/v2/user/guest/conference/registrations/count

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json

FortiNAC F 7.4.0 REST API 775

Fortinet Inc.
Get /user/guest/conference/registrations/count

Header

Sample Response

{
"status": "string",
"errorMessage": "string",
"filtered": 0,
"total": 0,
"results": [
{
"version": 0,
"guestID": 0,
"startTime": "2024-04-11T21:23:10.121Z",
"endTime": "2024-04-11T21:23:10.121Z",
"userID": "string",
"sponsor": "string",
"role": "string",
"policy": "string",
"regType": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"registrationCount": 0,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"timeOfDayString": "string",
"regTypeString": "string",
"availability": "string"
}
]
}

FortiNAC F 7.4.0 REST API 776

Fortinet Inc.
Get /user/guest/count/all

Get /user/guest/count/all

Description

Returns the count of all guest account records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 777

Fortinet Inc.
Get /user/guest/count/all

Sample Response

FortiNAC F 7.4.0 REST API 778

Fortinet Inc.
Get /user/guest/count/all

{
"status": "string",
"errorMessage": "string",
"conferenceRegistrations": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"results": [
{
"landscape": 0,
"id": 0,
"role": "string",
"policy": "string",
"firstName": "string",
"lastName": "string",
"sponsor": "string",
"visitorType": 0,
"assetTag": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-08T01:39:36.641Z",
"validForTime": "2023-11-08T01:39:36.641Z",
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"country": "string",
"reason": "string",
"personVisiting": "string",
"canSendEmail": true,
"canSendSMS": true,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"reauthenticationPeriod": 0,
"accountEnabled": true,
"dataFields": "string",
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
FortiNAC F 7.4.0
}, REST API 779
Fortinet Inc. "terminateAtEndOfDay": true,
"printedNote": "string",
"numConferenceAttendees": 0,
Get /user/guest/count/all

FortiNAC F 7.4.0 REST API 780

Fortinet Inc.
Get /user/guest/{id}/get-password

Get /user/guest/{id}/get-password

Description

Gets the password from the guest record using the provided record id, if possible.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest/1/get-password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 781

Fortinet Inc.
Get /user/guest/{id}/get-password

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 782

Fortinet Inc.
Get /user/guest/{id}

Get /user/guest/{id}

Description

Returns the guest account record with the supplied DBID.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 783

Fortinet Inc.
Get /user/guest/{id}

Sample Response

FortiNAC F 7.4.0 REST API 784

Fortinet Inc.
Get /user/guest/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"id": 1,
"clientID": -1,
"role": "GuestAccess",
"policy": null,
"firstName": "test",
"lastName": "test",
"sponsor": "admin",
"visitorType": 0,
"assetTag": null,
"email": "[email protected]",
"userID": "[email protected]",
"password": "",
"creationTime": 1699482047000,
"validForTime": 1700726399000,
"address": null,
"city": null,
"mailState": null,
"zipCode": null,
"phone": null,
"country": null,
"reason": null,
"personVisiting": null,
"canSendEmail": false,
"canSendSMS": false,
"aupURL": null,
"aupIP": null,
"successURL": "http://www.google.com",
"successIP": "",
"reauthenticationPeriod": -1,
"accountEnabled": true,
"dataFields": "",
"authType": 0,
"authServer": -1,
"regType": 0,
"weeklySchedule": {
"version": 1.1,
"startTimeOfDay": -1,
"endTimeOfDay": -1,
"daysOfWeek": -1,
"alwaysOn": true,
"validTime": true,
"endTimeOfDayAM": true,
"startTimeOfDayAM": true,
"startTimeOfDayHours": 12,
"endTimeOfDayHours": 12,
"startTimeOfDayMinutes": -1,
"endTimeOfDayMinutes": -1
},
"printedNote": null,
"clientIds": [
5
],
"numConferenceAttendees": -1,
"mobileProvider": null,
"mobileNumber": null,
FortiNAC F 7.4.0 REST API
"conferenceName": null, 785
Fortinet Inc. "accountDuration": -1,
"ncmPropagateHosts": true,
"passwordExclusions": "!@#$%^&*()_+~{}|:\"<>?`-=
Get /user/guest/{id}

FortiNAC F 7.4.0 REST API 786

Fortinet Inc.
Post /user/guest

Post /user/guest

Description

Adds a new guest record to the database using the provided guest template and sponsor.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

template Optional String

templateID Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"clientID": 0,
"role": "string",

FortiNAC F 7.4.0 REST API 787

Fortinet Inc.
Post /user/guest

"policy": "string",
"firstName": "string",
"lastName": "string",
"sponsor": "string",
"visitorType": 0,
"assetTag": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-08T00:44:44.542Z",
"validForTime": "2023-11-08T00:44:44.542Z",
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"country": "string",
"reason": "string",
"personVisiting": "string",
"canSendEmail": true,
"canSendSMS": true,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"reauthenticationPeriod": 0,
"accountEnabled": true,
"dataFields": "string",
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"numConferenceAttendees": 0,
"mobileProvider": "string",
"mobileNumber": "string",
"conferenceName": "string",
"accountDuration": 0,

FortiNAC F 7.4.0 REST API 788

Fortinet Inc.
Post /user/guest

"ncmPropagateHosts": true,
"passwordExclusions": "string",
"sendPasswordSeparately": true,
"minPwLength": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-08T00:44:44.542Z",
"userStartTimeStr": "string",
"userEndTimeStr": "string",
"encodedPassword": "string",
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"timeOfDayString": "string",
"loginAvailabilityString": "string",
"authTypeName": "string",
"daysOfWeekString": "string",
"guestValid": true,
"userStartTime": "2023-11-08T00:44:44.542Z",
"userEndTime": "2023-11-08T00:44:44.542Z",
"conference": true,
"individualUserName": true,
"sharedUserName": true,
"clientIDs": [
0
],
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"alwaysOn": true,
"type": "string",
"creationTimeMillis": 0,
"validForTimeMillis": 0
}

FortiNAC F 7.4.0 REST API 789

Fortinet Inc.
Post /user/guest

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 790

Fortinet Inc.
Post /user/guest/bulk

Post /user/guest/bulk

Description

Creates one or more guest accounts in a single request, each using the same guest template. The template may be
provided by either name or ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

template Optional String

templateID Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/builk

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"clientID": 0,

FortiNAC F 7.4.0 REST API 791

Fortinet Inc.
Post /user/guest/bulk

"role": "string",
"policy": "string",
"firstName": "string",
"lastName": "string",
"sponsor": "string",
"visitorType": 0,
"assetTag": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-08T00:44:44.542Z",
"validForTime": "2023-11-08T00:44:44.542Z",
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"country": "string",
"reason": "string",
"personVisiting": "string",
"canSendEmail": true,
"canSendSMS": true,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"reauthenticationPeriod": 0,
"accountEnabled": true,
"dataFields": "string",
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"numConferenceAttendees": 0,
"mobileProvider": "string",
"mobileNumber": "string",
"conferenceName": "string",

FortiNAC F 7.4.0 REST API 792

Fortinet Inc.
Post /user/guest/bulk

"accountDuration": 0,
"ncmPropagateHosts": true,
"passwordExclusions": "string",
"sendPasswordSeparately": true,
"minPwLength": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-08T00:44:44.542Z",
"userStartTimeStr": "string",
"userEndTimeStr": "string",
"encodedPassword": "string",
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"timeOfDayString": "string",
"loginAvailabilityString": "string",
"authTypeName": "string",
"daysOfWeekString": "string",
"guestValid": true,
"userStartTime": "2023-11-08T00:44:44.542Z",
"userEndTime": "2023-11-08T00:44:44.542Z",
"conference": true,
"individualUserName": true,
"sharedUserName": true,
"clientIDs": [
0
],
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"alwaysOn": true,
"type": "string",
"creationTimeMillis": 0,
"validForTimeMillis": 0
}

FortiNAC F 7.4.0 REST API 793

Fortinet Inc.
Post /user/guest/bulk

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 794

Fortinet Inc.
Post /user/guest/{id}/delete

Post /user/guest/{id}/delete

Description

Deletes the guest account record supplied, if it is not currently in use.

Parameter

Id, the Id of the guest account record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 795

Fortinet Inc.
Post /user/guest/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 796

Fortinet Inc.
Post /user/guest/{id}

Post /user/guest/{id}

Description

Updates an existing guest account record in the database.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"clientID": 0,
"role": "string",
"policy": "string",
"firstName": "string",
"lastName": "string",
"sponsor": "string",

FortiNAC F 7.4.0 REST API 797

Fortinet Inc.
Post /user/guest/{id}

"visitorType": 0,
"assetTag": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-08T00:44:44.542Z",
"validForTime": "2023-11-08T00:44:44.542Z",
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"country": "string",
"reason": "string",
"personVisiting": "string",
"canSendEmail": true,
"canSendSMS": true,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"reauthenticationPeriod": 0,
"accountEnabled": true,
"dataFields": "string",
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"numConferenceAttendees": 0,
"mobileProvider": "string",
"mobileNumber": "string",
"conferenceName": "string",
"accountDuration": 0,
"ncmPropagateHosts": true,
"passwordExclusions": "string",
"sendPasswordSeparately": true,
"minPwLength": 0,

FortiNAC F 7.4.0 REST API 798

Fortinet Inc.
Post /user/guest/{id}

"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-08T00:44:44.542Z",
"userStartTimeStr": "string",
"userEndTimeStr": "string",
"encodedPassword": "string",
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"timeOfDayString": "string",
"loginAvailabilityString": "string",
"authTypeName": "string",
"daysOfWeekString": "string",
"guestValid": true,
"userStartTime": "2023-11-08T00:44:44.542Z",
"userEndTime": "2023-11-08T00:44:44.542Z",
"conference": true,
"individualUserName": true,
"sharedUserName": true,
"clientIDs": [
0
],
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"alwaysOn": true,
"type": "string",
"creationTimeMillis": 0,
"validForTimeMillis": 0
}

FortiNAC F 7.4.0 REST API 799

Fortinet Inc.
Post /user/guest/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 800

Fortinet Inc.
Post /user/guest/generate-password-from-template

Post /user/guest/generate-password-from-template

Description

Generates a new password compliant with the guest template using the provided template Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

templateID Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/generate-

password-from-template

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body templateID: xx

FortiNAC F 7.4.0 REST API 801

Fortinet Inc.
Post /user/guest/generate-password-from-template

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 802

Fortinet Inc.
Post /user/guest/{id}/disable

Post /user/guest/{id}/disable

Description

Disables the supplied guest account.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/1/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 803

Fortinet Inc.
Post /user/guest/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 804

Fortinet Inc.
Post /user/guest/{id}/generate-password

Post /user/guest/{id}/generate-password

Description

Generates a new password using the template associated with the guest record, but does not modify that guest record.

Parameter

Id, the Id of the guest record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/1/generate-

password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 805

Fortinet Inc.
Post /user/guest/{id}/generate-password

Sample Response

{
"status": "success",
"errorMessage": null,
"results": "eNRd6wJk"
}

FortiNAC F 7.4.0 REST API 806

Fortinet Inc.
Post /user/guest/delete

Post /user/guest/delete

Description

Deletes the guest account record or records supplied, if they are none are currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 807

Fortinet Inc.
Post /user/guest/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 808

Fortinet Inc.
Post /user/guest/{id}/enable

Post /user/guest/{id}/enable

Description

Enables the supplied guest account.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/1/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 809

Fortinet Inc.
Post /user/guest/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 810

Fortinet Inc.
Post /user/guest/get-password

Post /user/guest/get-password

Description

Gets the password from the guest record using the provided record id, if possible.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/get-password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

FortiNAC F 7.4.0 REST API 811

Fortinet Inc.
Post /user/guest/get-password

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 812

Fortinet Inc.
Post /user/guest/reset-password

Post /user/guest/reset-password

Description

Resets the password for one or more guest accounts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/reset-password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:2

FortiNAC F 7.4.0 REST API 813

Fortinet Inc.
Post /user/guest/reset-password

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 814

Fortinet Inc.
Post /user/guest/send-email

Post /user/guest/send-email

Description

Sends an email to one or more email addresses associated with the supplied guest account ids.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

messageTemplate Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/send-email

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body templateID: xx

messageTemplate: xxxxx

FortiNAC F 7.4.0 REST API 815

Fortinet Inc.
Post /user/guest/send-email

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 816

Fortinet Inc.
Post /user/guest/conference

Post /user/guest/conference

Description

Creates a conference account and any subsequent guest accounts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Optional String

type Optional String

attendeeCount Optional Integer

startTime Optional Integer

endTime Optional Integer

templateID Optional Integer

password Optional String

FortiNAC F 7.4.0 REST API 817

Fortinet Inc.
Post /user/guest/conference

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/conference

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "groupmeeting"

type: "client"
attendeeCount: 12
startTime: 1699482047000
endTime:1700726399000
templateID: "4531267"
password: "***************"

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
}

FortiNAC F 7.4.0 REST API 818

Fortinet Inc.
Post /user/guest/send-sms

Post /user/guest/send-sms

Description

Sends a SMS to one ore more mobile numbers associated with the supplied guest account ids.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

messageTemplate Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest/send-sms

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body templateID: xx

messageTemplate: xxxxx

FortiNAC F 7.4.0 REST API 819

Fortinet Inc.
Post /user/guest/send-sms

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 820

Fortinet Inc.
Delete /user/guest/{id}

Delete /user/guest/{id}

Description

Deletes the guest account record supplied, if it is not currently in use.

Parameter

Id, the DBID of the guest ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/guest/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 821

Fortinet Inc.
Delete /user/guest/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 822

Fortinet Inc.
Host Record

Host Record

FortiNAC F 7.4.0 REST API 823

Fortinet Inc.
Get /host/by-ip/{ip}

Get /host/by-ip/{ip}

Description

Returns the Host Record that matches the supplied IP address.

Parameter

ip, the ip address of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/by-mac/172.45.123.45

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 824

Fortinet Inc.
Get /host/by-ip/{ip}

Sample Response

FortiNAC F 7.4.0 REST API 825

Fortinet Inc.
Get /host/by-ip/{ip}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2023-11-09T23:22:12.627Z",
"validForTime": "2023-11-09T23:22:12.627Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
FortiNAC F 7.4.0 REST
"id": 0, API 826
Fortinet Inc. "role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
Get /host/by-ip/{ip}

FortiNAC F 7.4.0 REST API 827

Fortinet Inc.
Get /host/by-mac/{mac}

Get /host/by-mac/{mac}

Description

Returns the Host Record that matches the supplied MAC address.

Parameter

mac, the MAC address of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/by-

mac/00:09:0F:AA:00:02

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 828

Fortinet Inc.
Get /host/by-mac/{mac}

Sample Response

FortiNAC F 7.4.0 REST API 829

Fortinet Inc.
Get /host/by-mac/{mac}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2023-11-09T23:22:12.627Z",
"validForTime": "2023-11-09T23:22:12.627Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
FortiNAC F 7.4.0 REST
"id": 0, API 830
Fortinet Inc. "role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
Get /host/by-mac/{mac}

FortiNAC F 7.4.0 REST API 831

Fortinet Inc.
Get /host/count/all

Get /host/count/all

Description

Returns the count of all Host Records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 832

Fortinet Inc.
Get /host/count/all

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 141
}

FortiNAC F 7.4.0 REST API 833

Fortinet Inc.
Get /host/device-types

Get /host/device-types

Description

Returns all private Client Filters, used multifilter queries. If allowed, shared Client Filters are also included.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-types

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 834

Fortinet Inc.
Get /host/device-types

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"id": 28,
"name": "Alarm System",
"tag": "security",
"smIcon":
"/applets/icons/device/generated/security_
16.png",
"lgIcon":
"/applets/icons/device/generated/security_
16.png",
"isDefault": true
},
{
"id": 32,
"name": "Android",
"tag": "android",
"smIcon":
"/applets/icons/device/generated/android_
16.png",
"lgIcon":
"/applets/icons/device/generated/android_
16.png",
"isDefault": true
}
]
}

FortiNAC F 7.4.0 REST API 835

Fortinet Inc.
Get /host/connected-to-port

Get /host/connected-to-port

Description

Returns a list of Host Records connected to the port id provided.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

portID Required Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/connected-to-port

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body portID: xxxx

FortiNAC F 7.4.0 REST API 836

Fortinet Inc.
Get /host/connected-to-port

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 837

Fortinet Inc.
Get /host/{id}

Get /host/{id}

Description

Returns the Host Record with the supplied DBID.

Parameter

Id, the DBID of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 838

Fortinet Inc.
Get /host/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 119
}

FortiNAC F 7.4.0 REST API 839

Fortinet Inc.
Get /host/{id}/usage

Get /host/{id}/usage

Description

Returns a list of records that reference this Host Record.

Parameter

Id, the DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 840

Fortinet Inc.
Get /host/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null
"results": []

FortiNAC F 7.4.0 REST API 841

Fortinet Inc.
Get /host/count

Get /host/count

Description

Returns the count of all Host Records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[string]

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 842

Fortinet Inc.
Get /host/count

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 141
}

FortiNAC F 7.4.0 REST API 843

Fortinet Inc.
Get /host/for-user

Get /host/for-user

Description

Returns a list of Host Records for the user object with the provided id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/for-user

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body userID: xx

FortiNAC F 7.4.0 REST API 844

Fortinet Inc.
Get /host/for-user

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 845

Fortinet Inc.
Get /host/global-allowed-hosts

Get /host/global-allowed-hosts

Description

Returns the count of allowed Host Records on this system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/global-allowed-hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 846

Fortinet Inc.
Get /host/global-allowed-hosts

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 847

Fortinet Inc.
Get /host/client-filters/cached/{name}

Get /host/client-filters/cached/{name}

Description

Returns the cached filter with the supplied name.

Request Parameter

name, name of the cached filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/client-

filters/cached/xxxxxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 848

Fortinet Inc.
Get /host/client-filters/cached/{name}

Sample Response

FortiNAC F 7.4.0 REST API 849

Fortinet Inc.
Get /host/client-filters/cached/{name}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"filterName": "string",
"isShared": true,
"filterType": "string",
"orFilter": "string",
"adapConnected": "string",
"adapEnabled": "string",
"adapValidMac": "string",
"adapIP": "string",
"adapLocation": "string",
"adapConnectedContainer": "string",
"adapDpcRuleName": "string",
"adapVendorName": "string",
"adapAccessVal": "string",
"adapMediaType": "string",
"adapAuthType": "string",
"adapInnerEapType": "string",
"adapOuterEapType": "string",
"adapDescr": "string",
"adapMac": "string",
"hostID": "string",
"hostConnected": "string",
"hostEnabled": "string",
"hostSecurity": "string",
"hostVulnerabilityScanStatus": "string",
"hostCreatedStart": 0,
"hostCreatedEnd": 0,
"hostCreatedLastX": 0,
"hostExpirationStart": 0,
"hostExpirationEnd": 0,
"hostInactivityStart": 0,
"hostInactivityEnd": 0,
"hostInactivityLastX": 0,
"hostVulnerabilityScanStart": 0,
"hostVulnerabilityScanLastX": 0,
"hostExpirationLastX": 0,
"hostLastContactLastX": 0,
"hostCreatedPeriod": "string",
"hostExpirationPeriod": "string",
"hostInactivityPeriod": "string",
"hostLastContactStart": "string",
"hostLastContactEnd": "string",
"hostLastContactPeriod": "string",
"hostVulnerabilityScanEnd": "string",
"hostVulnerabilityScanPeriod": "string",
"hostAppName": "string",
"hostAppCategory": "string",
"hostHasPAgent": "string",
"hostPACommunicating": "string",
"hostAgentVersion": "string",
"hostAgentPlatform": "string",
"hostRole": "string",
"hostSecurityAccessVal": "string",
"hostHostName": "string",
"hostOwner": "string",
FortiNAC F 7.4.0 REST API
"hostCurrentUser": "string", 850
Fortinet Inc. "hostVPNClient": "string",
"hostOS": "string",
"hostAgentTag": "string",
Get /host/client-filters/cached/{name}

FortiNAC F 7.4.0 REST API 851

Fortinet Inc.
Get /host/{id}/policy

Get /host/{id}/policy

Description

Returns the policy info for a Host Record based on the provided id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/32/policy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:xxxx

FortiNAC F 7.4.0 REST API 852

Fortinet Inc.
Get /host/{id}/policy

Sample Response

FortiNAC F 7.4.0 REST API 853

Fortinet Inc.
Get /host/{id}/policy

{
"status": "success",
"errorMessage": null,
"accessPolicy": null,
"accessPolicyDebug": null,
"supplicantPolicy": null,
"supplicantPolicyDebug": null,
"epcPolicy": null,
"epcPolicyDebug": null,
"portalPolicy": null,
"portalPolicyDebug": null
"authenticationPolicy": {
"dbid": 3,
"rank": 2,
"version": 0,
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-09-21T22:58:21.000+0000",
"name": "Guest Self-Registration Access Policy 2",
"note": "",
"profile": {
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-09-
21T22:58:21.000+0000",
"DBID": 3,
"name": "Role Test 3",
"note": "",
"locationOperator": "OR",
"groupOperator": "OR",
"GUID": null,
"globalModifiedDate": "2023-09-
21T22:58:21.000+0000",
"groupNames": [],
"weeklySchedule": {
"version": 1.1,
"startTimeOfDay": -1,
"endTimeOfDay": -1,
"daysOfWeek": -1,
"alwaysOn": true,
"validTime": true,
"endTimeOfDayAM": true,
"startTimeOfDayAM": true,
"startTimeOfDayHours": 12,
"endTimeOfDayHours": 12,
"startTimeOfDayMinutes": -1,
"endTimeOfDayMinutes": -1
},
"groupIDs": [],
"locationIDs": [],
"filterSet": [],
"locationNames": [],
"catchAll": true,
"radiusFilterSet": []
},
"configuration": {
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication
Policy - Fri Aug 25 13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
FortiNAC F 7.4.0 REST API
"reauthentication": false, 854
Fortinet Inc. "reauthenticationTime": 0,
"errorMessage": null,
"lastModifiedBy": "SYSTEM",
Get /host/{id}/policy

FortiNAC F 7.4.0 REST API 855

Fortinet Inc.
Get /host/client-filters

Get /host/client-filters

Description

Returns all private Client Filters, used for multi-filter queries. If allowed, shared Client Filters are also included.

Request Parameter

Id, the DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

serverIP Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/client-filters

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 856

Fortinet Inc.
Get /host/client-filters

Request Body serverIP: xxxxxxxxx

FortiNAC F 7.4.0 REST API 857

Fortinet Inc.
Get /host/client-filters

Sample Response

FortiNAC F 7.4.0 REST API 858

Fortinet Inc.
Get /host/client-filters

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"filterName": "string",
"isShared": true,
"filterType": "string",
"orFilter": "string",
"adapConnected": "string",
"adapEnabled": "string",
"adapValidMac": "string",
"adapIP": "string",
"adapLocation": "string",
"adapConnectedContainer": "string",
"adapDpcRuleName": "string",
"adapVendorName": "string",
"adapAccessVal": "string",
"adapMediaType": "string",
"adapAuthType": "string",
"adapInnerEapType": "string",
"adapOuterEapType": "string",
"adapDescr": "string",
"adapMac": "string",
"hostID": "string",
"hostConnected": "string",
"hostEnabled": "string",
"hostSecurity": "string",
"hostVulnerabilityScanStatus": "string",
"hostCreatedStart": 0,
"hostCreatedEnd": 0,
"hostCreatedLastX": 0,
"hostExpirationStart": 0,
"hostExpirationEnd": 0,
"hostInactivityStart": 0,
"hostInactivityEnd": 0,
"hostInactivityLastX": 0,
"hostVulnerabilityScanStart": 0,
"hostVulnerabilityScanLastX": 0,
"hostExpirationLastX": 0,
"hostLastContactLastX": 0,
"hostCreatedPeriod": "string",
"hostExpirationPeriod": "string",
"hostInactivityPeriod": "string",
"hostLastContactStart": "string",
"hostLastContactEnd": "string",
"hostLastContactPeriod": "string",
"hostVulnerabilityScanEnd": "string",
"hostVulnerabilityScanPeriod": "string",
"hostAppName": "string",
"hostAppCategory": "string",
"hostHasPAgent": "string",
"hostPACommunicating": "string",
"hostAgentVersion": "string",
"hostAgentPlatform": "string",
"hostRole": "string",
"hostSecurityAccessVal": "string",
"hostHostName": "string",
"hostOwner": "string",
FortiNAC F 7.4.0 REST API
"hostCurrentUser": "string", 859
Fortinet Inc. "hostVPNClient": "string",
"hostOS": "string",
"hostAgentTag": "string",
Get /host/client-filters

FortiNAC F 7.4.0 REST API 860

Fortinet Inc.
Get /host/recent

Get /host/recent

Description

Returns information about recently discovered Host Records grouped by OS.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Yes Integer

endDate Yes Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/recent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body startDate: xxxxxxxxx

endDate: xxxxxxxxxx

FortiNAC F 7.4.0 REST API 861

Fortinet Inc.
Get /host/recent

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 862

Fortinet Inc.
Post /host/delete

Post /host/delete

Description

Deletes the Host Record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 863

Fortinet Inc.
Post /host/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 864

Fortinet Inc.
Post /host/set-role

Post /host/set-role

Description

Sets the role for a list of Host Records.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

role Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/set-role

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: xxx

role: xxxxxx

FortiNAC F 7.4.0 REST API 865

Fortinet Inc.
Post /host/set-role

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 866

Fortinet Inc.
Post /host/{id}

Post /host/{id}

Description

Returns the Host Record with the supplied DBID.

Parameter

Id, the DBID of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2023-11-09T23:01:32.728Z",
"validForTime": "2023-11-09T23:01:32.728Z",
"lastSuccessfulPoll": 0,

FortiNAC F 7.4.0 REST API 867

Fortinet Inc.
Post /host/{id}

"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",

FortiNAC F 7.4.0 REST API 868

Fortinet Inc.
Post /host/{id}

"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-09T23:01:32.728Z",
"validForTime": "2023-11-09T23:01:32.728Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-09T23:01:32.728Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",

FortiNAC F 7.4.0 REST API 869

Fortinet Inc.
Post /host/{id}

"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 870

Fortinet Inc.
Post /host/{id}

"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"dummyClient": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2023-11-09T23:01:32.728Z",

FortiNAC F 7.4.0 REST API 871

Fortinet Inc.
Post /host/{id}

"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-09T23:01:32.728Z",
"validForTime": "2023-11-09T23:01:32.728Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-09T23:01:32.728Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",

FortiNAC F 7.4.0 REST API 872

Fortinet Inc.
Post /host/{id}

"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",

FortiNAC F 7.4.0 REST API 873

Fortinet Inc.
Post /host/{id}

"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.728Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true

FortiNAC F 7.4.0 REST API 874

Fortinet Inc.
Post /host/{id}

},
"name": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2023-11-09T23:01:32.729Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"device": true,
"ipaddress": "string",
"userID": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pctype": "string",
"operatingSystem": "string",
"hardwareType": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"iconType": "string",
"allIPsString": "string",
"authTypeStr": "string",

FortiNAC F 7.4.0 REST API 875

Fortinet Inc.
Post /host/{id}

"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",

FortiNAC F 7.4.0 REST API 876

Fortinet Inc.
Post /host/{id}

"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string",
"hostName": "string"
},
"dummyDate": "2023-11-09T23:01:32.729Z",
"dummyApplications": [
{
"dbid": 0,
"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2023-11-09T23:01:32.729Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-09T23:01:32.729Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"useKnownAdapters": true,
"groupId": 0,
"groupIds": [
0
],

FortiNAC F 7.4.0 REST API 877

Fortinet Inc.
Post /host/{id}

"ssidid": 0,
"radiusfingerprint": {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2023-11-09T23:01:32.729Z",
"lastHeardTime": "2023-11-09T23:01:32.729Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
}
}
},
"managedByMDM": true,
"mdmCompromised": true,
"mdmCompliance": true,
"mdmDataProtection": true,
"mdmPasscodePresent": true,
"inTopology": true,
"adaptersAsString": "string",
"ip": "string",
"validForTimeOffline": 0,
"atRisk": true,
"notCommunicatingPersistentAgent": true,
"persistentAgent": true,
"notAuthenticated": true,
"userLoggedOn": true,
"vpnclient": true,
"typeLabel": "string",
"primaryMac": "string",
"adapterObjects": [
{
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2023-11-09T23:01:32.729Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,

FortiNAC F 7.4.0 REST API 878

Fortinet Inc.
Post /host/{id}

"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-09T23:01:32.729Z",
"validForTime": "2023-11-09T23:01:32.729Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-09T23:01:32.729Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],

FortiNAC F 7.4.0 REST API 879

Fortinet Inc.
Post /host/{id}

"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,

FortiNAC F 7.4.0 REST API 880

Fortinet Inc.
Post /host/{id}

"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"host": "string",

FortiNAC F 7.4.0 REST API 881

Fortinet Inc.
Post /host/{id}

"clientState": "string",
"creationTime": "2023-11-09T23:01:32.729Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"device": true,
"ipaddress": "string",
"userID": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pctype": "string",
"operatingSystem": "string",
"hardwareType": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"iconType": "string",
"allIPsString": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"creationEvent": {
"landscape": 0,

FortiNAC F 7.4.0 REST API 882

Fortinet Inc.
Post /host/{id}

"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",

FortiNAC F 7.4.0 REST API 883

Fortinet Inc.
Post /host/{id}

"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string",
"hostName": "string"
}
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"operatingSystem": "string",
"offlineAgeTime": 0,
"pcserialNumber": "string",
"vulnerabilityScanStatus": 0,
"vulnerabilityScanDate": 0,
"connectedAdapter": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2023-11-09T23:01:32.729Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",

FortiNAC F 7.4.0 REST API 884

Fortinet Inc.
Post /host/{id}

"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2023-11-09T23:01:32.729Z",
"validForTime": "2023-11-09T23:01:32.729Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2023-11-09T23:01:32.729Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"

FortiNAC F 7.4.0 REST API 885

Fortinet Inc.
Post /host/{id}

},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",

FortiNAC F 7.4.0 REST API 886

Fortinet Inc.
Post /host/{id}

"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2023-11-09T23:01:32.729Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",

FortiNAC F 7.4.0 REST API 887

Fortinet Inc.
Post /host/{id}

"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"device": true,
"ipaddress": "string",
"userID": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pctype": "string",
"operatingSystem": "string",
"hardwareType": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"iconType": "string",
"allIPsString": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},

FortiNAC F 7.4.0 REST API 888

Fortinet Inc.
Post /host/{id}

"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string",
"hostName": "string"
},
"adapterIpAsString": "string",
"adapterLocation": "string",
"adapterContainerAsString": "string",
"pendingAtRisk": true,

FortiNAC F 7.4.0 REST API 889

Fortinet Inc.
Post /host/{id}

"disabled": true,
"agentPlatformEnum": "Windows",
"validTime": 0,
"expired": true,
"directoryDisabled": true,
"scanOnConnect": true,
"scanned": true,
"dialUpClient": true,
"messageReceiver": true,
"connected": true,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,

FortiNAC F 7.4.0 REST API 890

Fortinet Inc.
Post /host/{id}

"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-11-09T23:01:32.729Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 891

Fortinet Inc.
Post /host/{id}/enable

Post /host/{id}/enable

Description

Enables the Host Record that matches the supplied DBID.

Parameter

Id, the Id of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/2/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 892

Fortinet Inc.
Post /host/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 893

Fortinet Inc.
Post /host/{id}/disable

Post /host/{id}/disable

Description

Disables the Host Record that matches the supplied DBID.

Parameter

Id, the Id of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/2/diable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 894

Fortinet Inc.
Post /host/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 895

Fortinet Inc.
Post /host/import-hosts

Post /host/import-hosts

Description

Imports hosts into database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

file Yes object

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/import-hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body file: xxxxxxxxxx

FortiNAC F 7.4.0 REST API 896

Fortinet Inc.
Post /host/import-hosts

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 897

Fortinet Inc.
Post /host/with-adapters/{id}

Post /host/with-adapters/{id}

Description

Updates an existing Host Record in the database.

Paramter

Id, DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/with-adapters/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

FortiNAC F 7.4.0 REST API 898

Fortinet Inc.
Post /host/with-adapters/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 899

Fortinet Inc.
Post /host/{id}/set-health

Post /host/{id}/set-health

Description

Sets the health status of the Host Record for the provided id.

Parameter

Id, the Id of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

profileName Yes String

status Yes String

profileID Yes Integer

FortiNAC F 7.4.0 REST API 900

Fortinet Inc.
Post /host/{id}/set-health

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/32/set-health

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body profileName: xxxxxxxx

status: xxxxxxxxx
profileID:xxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 901

Fortinet Inc.
Post /host/{id}/delete

Post /host/{id}/delete

Description

Deletes the Host Record or records supplied, if it is not currently in use.

Parameter

Id, the DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 902

Fortinet Inc.
Post /host/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 903

Fortinet Inc.
Post /host/set-expiration

Post /host/set-expiration

Description

Sends a message to a list of Host Records via the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

setExpiration Optional Boolean

setInactivity Optional Boolean

expireDays Optional Integer

expireDateMS Optional Integer

InactiveDays Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/set-expiration

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 904

Fortinet Inc.
Post /host/set-expiration

Content-Type: application/json

Request Body id: xxxxx

setExpiration: xxxxx
setInactivity: xxxxx
expireDays: xxxxx
expireDateMS: xxxxx
InactiveDays: xxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 905

Fortinet Inc.
Post /host/trigger-scan

Post /host/trigger-scan

Description

Triggers a scan of Host Record for the ids provided.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/trigger-scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 906

Fortinet Inc.
Post /host/trigger-scan

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 907

Fortinet Inc.
Post /host/{id}/rescan-with-profile

Post /host/{id}/rescan-with-profile

Description

Re-Scans a Host Record with a particular script profile.

Request Parameter

Id, the DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

profileID Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/3/rescan-with-

profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 908

Fortinet Inc.
Post /host/{id}/rescan-with-profile

Request Body profileID: xxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 909

Fortinet Inc.
Post /host/send-persistent-agent-message

Post /host/send-persistent-agent-message

Description

Sends a message to a list of Host Records via the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

message Optional String

url Optional String

duration Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/send-persistent-

agent-message

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 910

Fortinet Inc.
Post /host/send-persistent-agent-message

Request Body id: xxxx

message: xxxxxxxxx
url: xxxxxxxxxxx
duration: xxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 911

Fortinet Inc.
Post /host/{id}/update-persistent-agent

Post /host/{id}/update-persistent-agent

Description

Updates the Persistent Agent for the Host Record with the provided id.

Request Parameter

Id, the DBID of the host record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

uuid Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/3/update-persistent-

agent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 912

Fortinet Inc.
Post /host/{id}/update-persistent-agent

Request Body uuid: xxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 913

Fortinet Inc.
Post /host/accept-imported-hosts

Post /host/accept-imported-hosts

Description

Accept the hosts Imported to add them into database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/accept-imported-

hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 914

Fortinet Inc.
Post /host/accept-imported-hosts

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 915

Fortinet Inc.
Delete /host/{id}

Delete /host/{id}

Description

Deletes the Host Record with the supplied DBID. If it is not currently in use.

Parameter

Id, the DBID of the Host Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 916

Fortinet Inc.
Delete /host/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 917

Fortinet Inc.
Host Registration Request

Host Registration Request

FortiNAC F 7.4.0 REST API 918

Fortinet Inc.
Get /host/registration-request

Get /host/registration-request

Description

Returns a list of Host Registration Request records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/registration-request

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 919

Fortinet Inc.
Get /host/registration-request

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"approver": "string",
"ip": "string",
"mac": "string",
"location": "string",
"state": "ACCEPTED",
"createDate": "2024-04-25T21:17:11.029Z",
"expireDate": "2024-04-25T21:17:11.029Z",
"responseDate": "2024-04-25T21:17:11.029Z",
"userID": "string",
"requestKey": "string",
"requestSource": "PORTAL_STANDARD_USER",
"requestSourceName": "string",
"approverGroup": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 920

Fortinet Inc.
Get /host/registration-request/{id}

Get /host/registration-request/{id}

Description

Returns a list of Host Registration Request records matching the supplied filter.

Request Parameter

Id, the Host Registration Request ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/registration-

request/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 921

Fortinet Inc.
Get /host/registration-request/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"approver": "string",
"ip": "string",
"mac": "string",
"location": "string",
"state": "ACCEPTED",
"createDate": "2024-04-25T21:17:11.029Z",
"expireDate": "2024-04-25T21:17:11.029Z",
"responseDate": "2024-04-25T21:17:11.029Z",
"userID": "string",
"requestKey": "string",
"requestSource": "PORTAL_STANDARD_USER",
"requestSourceName": "string",
"approverGroup": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 922

Fortinet Inc.
Post /host/registration-request/deny

Post /host/registration-request/deny

Description

Denies one or more Host Registration requests. Requests must be pending to be denied.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/registration-

request/deny

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": [
0
]
}

FortiNAC F 7.4.0 REST API 923

Fortinet Inc.
Post /host/registration-request/deny

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 924

Fortinet Inc.
Post /host/registration-request/{id}/delete

Post /host/registration-request/{id}/delete

Description

Deletes a single Host Registration Request record by ID.

Parameter

Id, DBID of the host registration request.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/registration-

request/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 925

Fortinet Inc.
Post /host/registration-request/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 926

Fortinet Inc.
Post /host/registration-request/delete

Post /host/registration-request/delete

Description

Deletes a list of Host Registration Request records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/registration-

request/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 927

Fortinet Inc.
Post /host/registration-request/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 928

Fortinet Inc.
Post /host/registration-request/approve

Post /host/registration-request/approve

Description

Approves one or more Host Registration requests. Requests must be pending to be approved.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/registration-

request/approve

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": [
0
]
}

FortiNAC F 7.4.0 REST API 929

Fortinet Inc.
Post /host/registration-request/approve

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 930

Fortinet Inc.
Delete /host/registration-request/{id}

Delete /host/registration-request/{id}

Description

Deletes a single Host Registration Request record by ID.

Request Parameter

Id, the Host Registration Request ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/registration-

request/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 931

Fortinet Inc.
Delete /host/registration-request/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 932

Fortinet Inc.
L3 Scan

L3 Scan

FortiNAC F 7.4.0 REST API 933

Fortinet Inc.
Get /device/l3scan/status

Get /device/l3scan/status

Description

Returns the results for the last completed scan or the one currently in progress.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/l3scan/status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 934

Fortinet Inc.
Get /device/l3scan/status

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 935

Fortinet Inc.
Post /device/l3scan/stop

Post /device/l3scan/stop

Description

Stops an L3 scan if it is currently running.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/l3scan/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 936

Fortinet Inc.
Post /device/l3scan/stop

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 937

Fortinet Inc.
Post /device/l3scan/start

Post /device/l3scan/start

Description

Starts an L3 scan of all the devices in order to identify potential L3 sources.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/l3scan/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 938

Fortinet Inc.
Post /device/l3scan/start

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 939

Fortinet Inc.
Logical Network Configuration

Logical Network Configuration

FortiNAC F 7.4.0 REST API 940

Fortinet Inc.
Get /policy/logical-network-configuration/element/properties

Get /policy/logical-network-
configuration/element/properties

Description

Returns all topology properties required to configure a device and the current configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

deviceID Required Integer

readFromDevice Optional Boolean

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/element/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body deviceID: xxxxxxxx

FortiNAC F 7.4.0 REST API 941

Fortinet Inc.
Get /policy/logical-network-configuration/element/properties

Sample Response

FortiNAC F 7.4.0 REST API 942

Fortinet Inc.
Get /policy/logical-network-configuration/element/properties

{
"status": "string",
"errorMessage": "string",
"vlanNames": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"vlanIDs": [
0
],
"radiusNames": [
"string"
],
"defaultPrimaryRadiusName": "string",
"defaultSecondaryRadiusName": "string",
"sourceIPAddr": "string",
"configs": {
"wiredDevice": true,
"wirelessDevice": true,
"wirelessController": true,
"usesIPPhones": true,
"usesEnable": true,
"usesSSH": true,
"useWiredAttributeForWireless": true,
"supportsRadius": true,
"hybridDevice": true,
"supportsMobilityVlan": true,
"excludeVlan": true,
"includeCaptivePortal": true,
"manageWebAuth": true,
"usesDisassociatePort": true,
"usesGuestVlan": true,
"usesSessionType": true,
"usesRoles": true,
"rfc5176Enabled": true,
"supportsForwardingTable": true,
"portChannelSupport": true,
"supportsVlanName": true,
"specialDevice": true,
"noVoiceVLAN": true,
"supportsFirewallTags": true,
"usesVDOM": true,
"supportsVPNAddressGroups": true,
"supportsSSOAddressGroups": true,
"devType": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"user_1": "string",
"telnetPW_1": "string",
"enablePW_1": "string",
"sessionID": "string",
"wapDomain": "string",
"chassisIPAddr": "string",
"slotLetter": "string",
"portMode": "string",
"EAPTerminate": "string",
"snmpVersion": "string",
FortiNAC F"disassociatePort":
7.4.0 REST API "string", 943
Fortinet Inc.
"usesCLIConfiguration": "string",
"chassisConfiguration": "string",
"deadVlan": "string",
Get /policy/logical-network-configuration/element/properties

FortiNAC F 7.4.0 REST API 944

Fortinet Inc.
Get /policy/logical-network-configuration

Get /policy/logical-network-configuration

Description

Returns a list of Host Registration Request records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 945

Fortinet Inc.
Get /policy/logical-network-configuration

Sample Response

FortiNAC F 7.4.0 REST API 946

Fortinet Inc.
Get /policy/logical-network-configuration

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-25T22:28:25.864Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-
25T22:28:25.864Z",
"id": 0,
"name": "_b7Y'ht|Dx *{wm&V&)_ Y",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-04-
25T22:28:25.865Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-25T22:28:25.865Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-04-
25T22:28:25.865Z",
"elementId": 0,
"logicalNetworkID": 0,
"rfc5176MessageType": "string",
"rfc5176AttributeGroup": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
FortiNAC F 7.4.0 "auditTableName":
REST API "string", 947
Fortinet Inc. "mysqlTableName": "string",
"idnameQuery": "string"
},
Get /policy/logical-network-configuration

FortiNAC F 7.4.0 REST API 948

Fortinet Inc.
Get /policy/logical-network-configuration/{id}

Get /policy/logical-network-configuration/{id}

Description

Returns a list of logical network records matching the supplied filter.

Parameter

Id, the id of the logical network record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 949

Fortinet Inc.
Get /policy/logical-network-configuration/{id}

Sample Response

FortiNAC F 7.4.0 REST API 950

Fortinet Inc.
Get /policy/logical-network-configuration/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-25T22:28:25.864Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-
25T22:28:25.864Z",
"id": 0,
"name": "_b7Y'ht|Dx *{wm&V&)_ Y",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-04-
25T22:28:25.865Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-04-25T22:28:25.865Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-04-
25T22:28:25.865Z",
"elementId": 0,
"logicalNetworkID": 0,
"rfc5176MessageType": "string",
"rfc5176AttributeGroup": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
FortiNAC F 7.4.0 "auditTableName":
REST API "string", 951
Fortinet Inc. "mysqlTableName": "string",
"idnameQuery": "string"
},
Get /policy/logical-network-configuration/{id}

FortiNAC F 7.4.0 REST API 952

Fortinet Inc.
Get /policy/logical-network-configuration/{id}/usage

Get /policy/logical-network-configuration/{id}/usage

Description

Returns a list of records that reference this logical network record.

Request Parameter

Id, the id of the logical network record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 953

Fortinet Inc.
Get /policy/logical-network-configuration/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 954

Fortinet Inc.
Get /policy/logical-network-configuration/radius

Get /policy/logical-network-configuration/radius

Description

Returns a list of configured RADIUS servers and the current default primary and secondary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/radius

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 955

Fortinet Inc.
Get /policy/logical-network-configuration/radius

Sample Response

{
"status": "success",
"errorMessage": null,
"defaultPrimaryRadiusName": null,
"defaultSecondaryRadiusName": null,
"results": []
}

FortiNAC F 7.4.0 REST API 956

Fortinet Inc.
Post /policy/logical-network-configuration

Post /policy/logical-network-configuration

Description

Creates a new logical network record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"id": 0,
"name": "]4%.c/'Xe06z$j",
"description": "string",
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {

FortiNAC F 7.4.0 REST API 957

Fortinet Inc.
Post /policy/logical-network-configuration

"user": "string",
"action": "string",
"timestamp": "2023-11-23T01:25:43.473Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"elementId": 0,
"logicalNetworkID": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"networkID": 0,
"task": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
},
"accessValue": "string",
"yamsEventTag": "string",
"accessActionStr": "string",
"logicalNetworkName": "string",
"id": 0,
"requestedTags": [
"string"
],

FortiNAC F 7.4.0 REST API 958

Fortinet Inc.
Post /policy/logical-network-configuration

"tags": [
"string"
]
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 959

Fortinet Inc.
Post /policy/logical-network-configuration/batch-upsert

Post /policy/logical-network-configuration/batch-upsert

Description

Performs add or modify requests for a series of logical network configurations at once.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/batch-upsert

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"id": 0,
"name": "]4%.c/'Xe06z$j",
"description": "string",
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {

FortiNAC F 7.4.0 REST API 960

Fortinet Inc.
Post /policy/logical-network-configuration/batch-upsert

"user": "string",
"action": "string",
"timestamp": "2023-11-23T01:25:43.473Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"elementId": 0,
"logicalNetworkID": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"networkID": 0,
"task": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
},
"accessValue": "string",
"yamsEventTag": "string",
"accessActionStr": "string",
"logicalNetworkName": "string",
"id": 0,
"requestedTags": [
"string"
],

FortiNAC F 7.4.0 REST API 961

Fortinet Inc.
Post /policy/logical-network-configuration/batch-upsert

"tags": [
"string"
]
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 962

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

Post /policy/logical-network-
configuration/element/properties

Description

Sets attributes for a number of devices in one request.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/element/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"elementIDs": [
0
],
"properties": {
"status": "string",
"errorMessage": "string",
"vlanNames": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"vlanIDs": [
0

FortiNAC F 7.4.0 REST API 963

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

],
"radiusNames": [
"string"
],
"defaultPrimaryRadiusName": "string",
"defaultSecondaryRadiusName": "string",
"configs": {
"wiredDevice": true,
"wirelessDevice": true,
"wirelessController": true,
"usesIPPhones": true,
"usesEnable": true,
"usesSSH": true,
"useWiredAttributeForWireless": true,
"supportsRadius": true,
"hybridDevice": true,
"supportsMobilityVlan": true,
"excludeVlan": true,
"includeCaptivePortal": true,
"manageWebAuth": true,
"usesDisassociatePort": true,
"usesGuestVlan": true,
"usesSessionType": true,
"usesRoles": true,
"rfc5176Enabled": true,
"supportsForwardingTable": true,
"portChannelSupport": true,
"supportsVlanName": true,
"specialDevice": true,
"noVoiceVLAN": true,
"supportsFirewallTags": true,
"usesVDOM": true,
"supportsVPNAddressGroups": true,
"devType": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"user_1": "string",
"telnetPW_1": "string",
"enablePW_1": "string",
"sessionID": "string",
"wapDomain": "string",
"chassisIPAddr": "string",
"slotLetter": "string",
"portMode": "string",
"EAPTerminate": "string",
"snmpVersion": "string",
"disassociatePort": "string",
"usesCLIConfiguration": "string",
"chassisConfiguration": "string",
"devMode": "string",
"opMode": "string",
"transMethod": "string",
"mobilityGroup": "string",

FortiNAC F 7.4.0 REST API 964

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

"mobilityVlan": "string",
"vlanNames": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"credentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"cliTimeout": "string",
"cliConnectTimeout": "string",
"routerCredentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"vlanFormat": "string",
"isClientBasedCLI": true,
"dot1xAutoRegister": true,
"defaultConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"defaultWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"registrationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"registrationWirelessConfig": {

FortiNAC F 7.4.0 REST API 965

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"remediationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"remediationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"authenticationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"authenticationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"deadEndConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"deadEndWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},

FortiNAC F 7.4.0 REST API 966

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

"guestConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"voiceVlanID": "string",
"chassisIP": "string",
"chassisSlot": "string",
"sessionID": "string",
"radiusEnabled": true,
"radiusMode": "string",
"radiusSecret": "string",
"primaryRadiusName": "string",
"secondaryRadiusName": "string",
"radiusServerConfigId": 0,
"radiusServerConfigs": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
],
"vdom": "string",
"portChannelSupport": true,
"usePortChannels": true,
"useSecurePorts": true,
"disassociatePort": "string",
"manageWebAuthMode": true,
"wapDomain": "string",
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"applyDefaultToPorts": true,
"vpnAddressGroup": "string"
}

FortiNAC F 7.4.0 REST API 967

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 968

Fortinet Inc.
Post /policy/logical-network-configuration/delete

Post /policy/logical-network-configuration/delete

Description

Deletes a list of logical network records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 969

Fortinet Inc.
Post /policy/logical-network-configuration/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 970

Fortinet Inc.
Post /policy/logical-network-configuration/{id}/delete

Post /policy/logical-network-configuration/{id}/delete

Description

Deletes a single logical network record by ID.

Request Parameter

Id, the id of the logical network record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 971

Fortinet Inc.
Post /policy/logical-network-configuration/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 972

Fortinet Inc.
Post /policy/logical-network-configuration/{id}

Post /policy/logical-network-configuration/{id}

Description

Updates an logical network record.

Parameter

Id, the id of the logical network record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,

FortiNAC F 7.4.0 REST API 973

Fortinet Inc.
Post /policy/logical-network-configuration/{id}

"logicalNetwork": {
"id": 0,
"name": "]4%.c/'Xe06z$j",
"description": "string",
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-11-23T01:25:43.473Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2023-11-23T01:25:43.473Z",
"elementId": 0,
"logicalNetworkID": 0,
"elementID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"networkID": 0,
"task": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0

FortiNAC F 7.4.0 REST API 974

Fortinet Inc.
Post /policy/logical-network-configuration/{id}

},
"accessValue": "string",
"yamsEventTag": "string",
"accessActionStr": "string",
"logicalNetworkName": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 975

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

Post /policy/logical-network-
configuration/element/properties/{deviceID}

Description

Updates the topology properties on a single device.

Request Parameter

deviceID, the device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"vlanNames": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0

FortiNAC F 7.4.0 REST API 976

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

},
"vlanIDs": [
0
],
"radiusNames": [
"string"
],
"defaultPrimaryRadiusName": "string",
"defaultSecondaryRadiusName": "string",
"configs": {
"wiredDevice": true,
"wirelessDevice": true,
"wirelessController": true,
"usesIPPhones": true,
"usesEnable": true,
"usesSSH": true,
"useWiredAttributeForWireless": true,
"supportsRadius": true,
"hybridDevice": true,
"supportsMobilityVlan": true,
"excludeVlan": true,
"includeCaptivePortal": true,
"manageWebAuth": true,
"usesDisassociatePort": true,
"usesGuestVlan": true,
"usesSessionType": true,
"usesRoles": true,
"rfc5176Enabled": true,
"supportsForwardingTable": true,
"portChannelSupport": true,
"supportsVlanName": true,
"specialDevice": true,
"noVoiceVLAN": true,
"supportsFirewallTags": true,
"usesVDOM": true,
"supportsVPNAddressGroups": true,
"devType": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"user_1": "string",
"telnetPW_1": "string",
"enablePW_1": "string",
"sessionID": "string",
"wapDomain": "string",
"chassisIPAddr": "string",
"slotLetter": "string",
"portMode": "string",
"EAPTerminate": "string",
"snmpVersion": "string",
"disassociatePort": "string",
"usesCLIConfiguration": "string",
"chassisConfiguration": "string",
"devMode": "string",

FortiNAC F 7.4.0 REST API 977

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

"opMode": "string",
"transMethod": "string",
"mobilityGroup": "string",
"mobilityVlan": "string",
"vlanNames": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"credentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"cliTimeout": "string",
"cliConnectTimeout": "string",
"routerCredentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",
"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"vlanFormat": "string",
"isClientBasedCLI": true,
"dot1xAutoRegister": true,
"defaultConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"defaultWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"registrationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",

FortiNAC F 7.4.0 REST API 978

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

"logicalNetwork": "string"
},
"registrationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"remediationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"remediationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"authenticationConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"authenticationWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"deadEndConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"deadEndWirelessConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,

FortiNAC F 7.4.0 REST API 979

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"guestConfig": {
"accessValue": "string",
"actionState": 0,
"cliConfig": 0,
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"logicalNetwork": "string"
},
"voiceVlanID": "string",
"chassisIP": "string",
"chassisSlot": "string",
"sessionID": "string",
"radiusEnabled": true,
"radiusMode": "string",
"radiusSecret": "string",
"primaryRadiusName": "string",
"secondaryRadiusName": "string",
"radiusServerConfigId": 0,
"radiusServerConfigs": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
],
"vdom": "string",
"portChannelSupport": true,
"usePortChannels": true,
"useSecurePorts": true,
"disassociatePort": "string",
"manageWebAuthMode": true,
"wapDomain": "string",
"radiusAttributeGroupId": 0,
"radiusResponseValues": "string",
"secureUnit1": "string",
"securePort1": "string",
"secureUnit2": "string",
"securePort2": "string",
"applyDefaultToPorts": true,
"vpnAddressGroup": "string"
}

FortiNAC F 7.4.0 REST API 980

Fortinet Inc.
Post /policy/logical-network-configuration/element/properties/{deviceID}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 981

Fortinet Inc.
Delete /policy/logical-network-configuration/{id}

Delete /policy/logical-network-configuration/{id}

Description

Deletes a single logical network record by ID.

Parameter

Id, the id of the logical network record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/logical-network-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 982

Fortinet Inc.
Delete /policy/logical-network-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 983

Fortinet Inc.
Mac Exclusion

Mac Exclusion

FortiNAC F 7.4.0 REST API 984

Fortinet Inc.
Get /settings/device/mac-exclusion

Get /settings/device/mac-exclusion

Description

Returns the currently configured Mac Exclusion Ranges.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/mac-

exclusion

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 985

Fortinet Inc.
Get /settings/device/mac-exclusion

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"startMac": "string",
"endMac": "string",
"dbid": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 986

Fortinet Inc.
Post /settings/device/mac-exclusion/delete

Post /settings/device/mac-exclusion/delete

Description

Deletes a Mac Exclusion range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

dbid Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/mac-

exclusion/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body dbid: 23

FortiNAC F 7.4.0 REST API 987

Fortinet Inc.
Post /settings/device/mac-exclusion/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 988

Fortinet Inc.
Post /settings/device/mac-exclusion

Post /settings/device/mac-exclusion

Description

Adds a Mac Exclusion range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startMac Yes String

endMac Yes String

dbid Yes Integer

name Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/mac-

exclusion

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 989

Fortinet Inc.
Post /settings/device/mac-exclusion

Request Body startMac: 50-84-91-81-17-EA

endMac: 50-84-91-81-18-EA
dbid: 23
name: tempMac

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 990

Fortinet Inc.
Message Template

Message Template

FortiNAC F 7.4.0 REST API 991

Fortinet Inc.
Get /settings/integration/message-template

Get /settings/integration/message-template

Description

Returns a list of Message Template records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/message-

template

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 992

Fortinet Inc.
Get /settings/integration/message-template

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-25T22:37:53.969Z",
"dbid": 0,
"name": "string",
"type": "SELF_REGISTRATION_REQUEST",
"subject": "string",
"message": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 993

Fortinet Inc.
Get /settings/integration/message-template/{id}

Get /settings/integration/message-template/{id}

Description

Returns a list of Message Template records matching the supplied filter.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/message-

template/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 994

Fortinet Inc.
Get /settings/integration/message-template/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-05T23:09:56.121Z",
"dbid": 0,
"name": "string",
"type": "SELF_REGISTRATION_REQUEST",
"subject": "string",
"message": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 995

Fortinet Inc.
Get /settings/integration/message-template/{id}/usage

Get /settings/integration/message-template/{id}/usage

Description

Returns a list of records that reference this Message Template record.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/message-

template/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 996

Fortinet Inc.
Get /settings/integration/message-template/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"children": [
"Portal"
],
"name": "Portal Configurations"
}
]
}

FortiNAC F 7.4.0 REST API 997

Fortinet Inc.
Post /settings/integration/message-template/test

Post /settings/integration/message-template/test

Description

Reviews the supplied Message Template with the supplied context.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/message-

template/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"template": {
"dbid": 0,
"name": "string",
"type": "SELF_REGISTRATION_REQUEST",
"subject": "string",
"message": "string"
},
"context": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}

FortiNAC F 7.4.0 REST API 998

Fortinet Inc.
Post /settings/integration/message-template/test

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 999

Fortinet Inc.
Post /settings/integration/message-template/{id}/delete

Post /settings/integration/message-template/{id}/delete

Description

Deletes a single Message Template record by ID.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/message-

template/3/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1000

Fortinet Inc.
Post /settings/integration/message-template/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1001

Fortinet Inc.
Post /settings/integration/message-template/{id}

Post /settings/integration/message-template/{id}

Description

Updates an Message Template record.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/message-

template/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"type": "SELF_REGISTRATION_REQUEST",
"subject": "string",
"message": "string"
}

FortiNAC F 7.4.0 REST API 1002

Fortinet Inc.
Post /settings/integration/message-template/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1003

Fortinet Inc.
Post /settings/integration/message-template/delete

Post /settings/integration/message-template/delete

Description

Deletes a list of Message Template records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/message-

template/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 1004

Fortinet Inc.
Post /settings/integration/message-template/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1005

Fortinet Inc.
Post /settings/integration/message-template

Post /settings/integration/message-template

Description

Creates a new Message Template record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/message-

template

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"type": "SELF_REGISTRATION_REQUEST",
"subject": "string",
"message": "string"
}

FortiNAC F 7.4.0 REST API 1006

Fortinet Inc.
Post /settings/integration/message-template

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1007

Fortinet Inc.
Delete /settings/integration/message-template/{id}

Delete /settings/integration/message-template/{id}

Description

Deletes a single Message Template record by ID.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/message-

template/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1008

Fortinet Inc.
Delete /settings/integration/message-template/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1009

Fortinet Inc.
Messaging Gateway

Messaging Gateway

FortiNAC F 7.4.0 REST API 1010

Fortinet Inc.
Get /settings/integration/messaging-gateway

Get /settings/integration/messaging-gateway

Description

Returns a list of Message Gateway records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1011

Fortinet Inc.
Get /settings/integration/messaging-gateway

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"name": "3 River Wireless",
"protocol": "SMTP",
"gatewayAddress": "[email protected]",
"country": "United States",
"maxMessageLength": -1,
"prefix": null,
"suffix": null,
"yamsEventTag": null,
"auditObj": null,
"enabled": false
}

],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 1012

Fortinet Inc.
Get /settings/integration/messaging-gateway/global/default-messaging-gateway

Get /settings/integration/messaging-
gateway/global/default-messaging-gateway

Description

Gets the default Message Gateway used to send sms.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/global/default-messaging-gateway

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1013

Fortinet Inc.
Get /settings/integration/messaging-gateway/global/default-messaging-gateway

Sample Response

{
"status": "success",
"errorMessage": null,
"result": ""
}

FortiNAC F 7.4.0 REST API 1014

Fortinet Inc.
Get /settings/integration/messaging-gateway/{id}

Get /settings/integration/messaging-gateway/{id}

Description

Returns a list of Message Gateway records matching the supplied filter.

Request Parameter

Id, the DBID of the message gateway.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1015

Fortinet Inc.
Get /settings/integration/messaging-gateway/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"name": "3 River Wireless",
"protocol": "SMTP",
"gatewayAddress": "[email protected]",
"country": "United States",
"maxMessageLength": -1,
"prefix": null,
"suffix": null,
"yamsEventTag": null,
"auditObj": null,
"enabled": false
}

],
"filtered": 1,
"total": 195
}

FortiNAC F 7.4.0 REST API 1016

Fortinet Inc.
Get /settings/integration/messaging-gateway/count/all

Get /settings/integration/messaging-gateway/count/all

Description

Returns the count of all messaging gateways in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1017

Fortinet Inc.
Get /settings/integration/messaging-gateway/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"gatewayAddress": "string",
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-12T23:20:42.281Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1018

Fortinet Inc.
Get /settings/integration/messaging-gateway/global/max-length

Get /settings/integration/messaging-gateway/global/max-
length

Description

Gets the maximum length of SMS messages for all providers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/global/max-length

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1019

Fortinet Inc.
Get /settings/integration/messaging-gateway/global/max-length

Sample Response

{
"status": "success",
"errorMessage": null,
"result": ""
}

FortiNAC F 7.4.0 REST API 1020

Fortinet Inc.
Get /settings/integration/messaging-gateway/count

Get /settings/integration/messaging-gateway/count

Description

Returns a count of messaging gateways matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1021

Fortinet Inc.
Get /settings/integration/messaging-gateway/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"gatewayAddress": "string",
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-12T23:20:42.281Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1022

Fortinet Inc.
Post /settings/integration/messaging-gateway/delete

Post /settings/integration/messaging-gateway/delete

Description

Deletes a list of Messaging Gateway records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:5

FortiNAC F 7.4.0 REST API 1023

Fortinet Inc.
Post /settings/integration/messaging-gateway/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1024

Fortinet Inc.
Post /settings/integration/messaging-gateway

Post /settings/integration/messaging-gateway

Description

Creates a new Messaging gateway, updating instead if the supplied messaging gateway has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"gatewayAddress": "string",
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-07T22:44:42.707Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,

FortiNAC F 7.4.0 REST API 1025

Fortinet Inc.
Post /settings/integration/messaging-gateway

"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0
}

FortiNAC F 7.4.0 REST API 1026

Fortinet Inc.
Post /settings/integration/messaging-gateway/global/default-messaging-gateway

Post /settings/integration/messaging-
gateway/global/default-messaging-gateway

Description

Sets the default Message Gateway used to send sms.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

defaultMessagingGateway Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gatewayglobal/default-messaging-gateway

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body defaultMessagingGateway: xxxxxxxxxxxxxxxxxx

FortiNAC F 7.4.0 REST API 1027

Fortinet Inc.
Post /settings/integration/messaging-gateway/global/default-messaging-gateway

Sample Response

{
"status": "success",
"errorMessage": null,
"result": ""
}

FortiNAC F 7.4.0 REST API 1028

Fortinet Inc.
Post /settings/integration/messaging-gateway/global/max-length

Post /settings/integration/messaging-gateway/global/max-
length

Description

Sets the maximum length of SMS messages for all providers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

maxLength Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/global/max-length

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body maxLength: 10

FortiNAC F 7.4.0 REST API 1029

Fortinet Inc.
Post /settings/integration/messaging-gateway/global/max-length

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1030

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}

Post /settings/integration/messaging-gateway/{id}

Description

Updates an Message gateway record.

Request Parameter

Id, the DBID of the message gateway.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"gatewayAddress": "string",
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",

FortiNAC F 7.4.0 REST API 1031

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}

"timestamp": "2023-12-07T22:44:42.707Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1032

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/delete

Post /settings/integration/messaging-gateway/{id}/delete

Description

Deletes a single Messaging Gateway record by ID.

Request Parameter

Id, the DBID of the message gateway.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1033

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1034

Fortinet Inc.
Post /settings/integration/messaging-gateway/send-sms

Post /settings/integration/messaging-gateway/send-sms

Description

Sends SMS

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/sned-sms

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {xxxxxxxxxxxx}

FortiNAC F 7.4.0 REST API 1035

Fortinet Inc.
Post /settings/integration/messaging-gateway/send-sms

Sample Response

{
"status": "success",
"errorMessage": null,
"result": null
}

FortiNAC F 7.4.0 REST API 1036

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/disable

Post /settings/integration/messaging-gateway/{id}/disable

Description

Disables the supplied Messaging Gateway.

Request Parameter

Id, the DBID of the message gateway.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/3/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1037

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1038

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/test

Post /settings/integration/messaging-gateway/{id}/test

Description

Test the gateway connection with the third party.

Request Parameter

Id, the DBID of the message gateway

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userId Optional Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/3/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1039

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/test

Request Body userId: xxxxxxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1040

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/enable

Post /settings/integration/messaging-gateway/{id}/enable

Description

Enables the supplied Messaging Gateway.

Request Parameter

Id, the DBID of the message gateway.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/3/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1041

Fortinet Inc.
Post /settings/integration/messaging-gateway/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1042

Fortinet Inc.
Delete /settings/integration/messaging-gateway/{id}

Delete /settings/integration/messaging-gateway/{id}

Description

Deletes a single Message gateway record by ID.

Request Parameter

Id, the DBID of the message template.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/messaging-

gateway/3

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1043

Fortinet Inc.
Delete /settings/integration/messaging-gateway/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1044

Fortinet Inc.
Nat Detection

Nat Detection

FortiNAC F 7.4.0 REST API 1045

Fortinet Inc.
Get /settings/device/NAT-detection

Get /settings/device/NAT-detection

FortiNAC F 7.4.0 REST API 1046

Fortinet Inc.
Description

Description

Returns the currently configured Properties.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/NAT-

detection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1047

Fortinet Inc.
Description

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"startIP": "string",
"endIP": "string",
"dbid": 0
}
]
}

FortiNAC F 7.4.0 REST API 1048

Fortinet Inc.
Post /settings/device/NAT-detection/ip-ranges

Post /settings/device/NAT-detection/ip-ranges

FortiNAC F 7.4.0 REST API 1049

Fortinet Inc.
Description

Description

Adds a new IP range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startIP Yes String

endIP Yes String

dbid Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/NAT-

detection/ip-ranges

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body startIP: 96.43.36.230

endIP: 96.43.36.245
dbid: 12

FortiNAC F 7.4.0 REST API 1050

Fortinet Inc.
Description

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1051

Fortinet Inc.
Post /settings/device/NAT-detection/ip-ranges/delete

Post /settings/device/NAT-detection/ip-ranges/delete

FortiNAC F 7.4.0 REST API 1052

Fortinet Inc.
Description

Description

Deletes one or more IP Ranges.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/NAT-

detection/ip-ranges/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:2

FortiNAC F 7.4.0 REST API 1053

Fortinet Inc.
Description

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1054

Fortinet Inc.
Post /settings/device/NAT-detection/ip-ranges/{id}

Post /settings/device/NAT-detection/ip-ranges/{id}

FortiNAC F 7.4.0 REST API 1055

Fortinet Inc.
Description

Description

Modified the existing IP ranges.

Request Parameter

Id, the DBID of the IP ranges.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startIP Yes String

endIP Yes String

dbid Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/NAT-

detection/ip-ranges/12

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1056

Fortinet Inc.
Description

Request Body startIP: 96.43.36.230

endIP: 96.43.36.245
dbid: 12

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1057

Fortinet Inc.
NCM-Operation

NCM-Operation

FortiNAC F 7.4.0 REST API 1058

Fortinet Inc.
AAA Server

AAA Server

FortiNAC F 7.4.0 REST API 1059

Fortinet Inc.
Delete /settings/integration/aaa/{id}

Delete /settings/integration/aaa/{id}

Description

Deletes the AAA Server record supplied, if it is not currently in use.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/aaa/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1060

Fortinet Inc.
Delete /settings/integration/aaa/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1061

Fortinet Inc.
Get /settings/integration/aaa

Get /settings/integration/aaa

Description

Returns all AAA Server records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1062

Fortinet Inc.
Get /settings/integration/aaa

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"checkUser": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:15:41.654Z",
"flrPriority": 0,
"localClientDefault": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1063

Fortinet Inc.
Get /settings/integration/aaa/count

Get /settings/integration/aaa/count

Description

Returns the count of all AAA Server records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1064

Fortinet Inc.
Get /settings/integration/aaa/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"checkUser": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:15:41.654Z",
"flrPriority": 0,
"localClientDefault": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1065

Fortinet Inc.
Get /settings/integration/aaa/count/all

Get /settings/integration/aaa/count/all

Description

Returns the count of all AAA Server records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/count/all

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1066

Fortinet Inc.
Get /settings/integration/aaa/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"checkUser": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:15:41.654Z",
"flrPriority": 0,
"localClientDefault": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1067

Fortinet Inc.
Get /settings/integration/aaa/{id}

Get /settings/integration/aaa/{id}

Description

Returns the AAA Server record with the supplied DBID

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1068

Fortinet Inc.
Get /settings/integration/aaa/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"checkUser": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:15:41.654Z",
"flrPriority": 0,
"localClientDefault": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1069

Fortinet Inc.
Get /settings/integration/aaa/{id}/secret

Get /settings/integration/aaa/{id}/secret

Description

Returns the secret stored for the AAA server.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/2/secret

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1070

Fortinet Inc.
Get /settings/integration/aaa/{id}/secret

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1071

Fortinet Inc.
Get /settings/integration/aaa/supportsValidation

Get /settings/integration/aaa/supportsValidation

Description

Returns false when legacy proxy radius is no longer supported and thus the validation user/pwd entry is no longer
applicable on a proxy server config.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Reques GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/2/supportsValidation

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header

FortiNAC F 7.4.0 REST API 1072

Fortinet Inc.
Get /settings/integration/aaa/supportsValidation

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": true
}

FortiNAC F 7.4.0 REST API 1073

Fortinet Inc.
Get /settings/integration/aaa/{id}/usage

Get /settings/integration/aaa/{id}/usage

Description

Returns a list of records that reference this AAA Server record.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1074

Fortinet Inc.
Get /settings/integration/aaa/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1075

Fortinet Inc.
Get /settings/integration/aaa/{id}/validate-user-password

Get /settings/integration/aaa/{id}/validate-user-password

Description

Returns the password stored for the Validation Account user.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/2/validate-user-

URL password

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1076

Fortinet Inc.
Get /settings/integration/aaa/{id}/validate-user-password

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1077

Fortinet Inc.
Get /settings/integration/aaa/validate/{id}

Get /settings/integration/aaa/validate/{id}

Description

Validate connectivity to the AAA server matching the specified ID.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/aaa/validate/2

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1078

Fortinet Inc.
Get /settings/integration/aaa/validate/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"dataMap": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"jsonString": "string",
"dataString": "string"
}
}

FortiNAC F 7.4.0 REST API 1079

Fortinet Inc.
Post /settings/integration/aaa

Post /settings/integration/aaa

Description

Adds a new AAA Server record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"secret": "string",
"checkUser": "string",
"checkPassword": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:19:18.793Z",
"flrPriority": 0,
"localClientDefault": true
}

FortiNAC F 7.4.0 REST API 1080

Fortinet Inc.
Post /settings/integration/aaa

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1081

Fortinet Inc.
Post /settings/integration/aaa/delete

Post /settings/integration/aaa/delete

Description

Deletes the AAA Server record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/aaa/delete

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1082

Fortinet Inc.
Post /settings/integration/aaa/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1083

Fortinet Inc.
Post /settings/integration/aaa/{id}/delete

Post /settings/integration/aaa/{id}/delete

Description

Deletes the AAA server record supplied, if it is not currently in use.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa/6/delete

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1084

Fortinet Inc.
Post /settings/integration/aaa/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1085

Fortinet Inc.
Post /settings/integration/aaa/{id}

Post /settings/integration/aaa/{id}

Description

Updates an existing AAA Server record in the database.

Request Parameter

Id, the AAA Server record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"secret": "string",
"checkUser": "string",
"checkPassword": "string",

FortiNAC F 7.4.0 REST API 1086

Fortinet Inc.
Post /settings/integration/aaa/{id}

"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:19:18.793Z",
"flrPriority": 0,
"localClientDefault": true
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1087

Fortinet Inc.
Post /settings/integration/aaa/validate

Post /settings/integration/aaa/validate

Description

Validate connectivity to the specified AAA server config.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/aaa/validate

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"netId": "string",
"authPort": 0,
"acctPort": 0,
"secret": "string",
"checkUser": "string",
"checkPassword": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-14T21:19:18.793Z",
"flrPriority": 0,
"localClientDefault": true
}

FortiNAC F 7.4.0 REST API 1088

Fortinet Inc.
Post /settings/integration/aaa/validate

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"dataMap": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"jsonString": "string",
"dataString": "string"
}
}

FortiNAC F 7.4.0 REST API 1089

Fortinet Inc.
Access Configuration

Access Configuration

FortiNAC F 7.4.0 REST API 1090

Fortinet Inc.
Delete /policy/access-configuration/{id}

Delete /policy/access-configuration/{id}

Description

Deletes a single Access Configuration record by ID.

Request Parameter

Id, the Access Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/access-

configuration/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1091

Fortinet Inc.
Delete /policy/access-configuration/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1092

Fortinet Inc.
Get /policy/access-configuration

Get /policy/access-configuration

Description

Returns a list of Access Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1093

Fortinet Inc.
Get /policy/access-configuration

Sample Response

FortiNAC F 7.4.0 REST API 1094

Fortinet Inc.
Get /policy/access-configuration

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"id": 0,
"name": "quW/ODuLVsP)?%rW^@pjP<M",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:31:56.110Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
FortiNAC F 7.4.0 "elementType":
REST API "string", 1095
Fortinet Inc. "nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
Get /policy/access-configuration

FortiNAC F 7.4.0 REST API 1096

Fortinet Inc.
Get /policy/access-configuration/count

Get /policy/access-configuration/count

Description

Returns a count of Access Configuration records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<Integer>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1097

Fortinet Inc.
Get /policy/access-configuration/count

Sample Response

FortiNAC F 7.4.0 REST API 1098

Fortinet Inc.
Get /policy/access-configuration/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"id": 0,
"name": "quW/ODuLVsP)?%rW^@pjP<M",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:31:56.110Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
FortiNAC F 7.4.0 "elementType":
REST API "string", 1099
Fortinet Inc. "nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
Get /policy/access-configuration/count

FortiNAC F 7.4.0 REST API 1100

Fortinet Inc.
Get /policy/access-configuration/count/all

Get /policy/access-configuration/count/all

Description

Returns a total count of all Access Configuration records.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1101

Fortinet Inc.
Get /policy/access-configuration/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1102

Fortinet Inc.
Get /policy/access-configuration/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"id": 0,
"name": "quW/ODuLVsP)?%rW^@pjP<M",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:31:56.110Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
FortiNAC F 7.4.0 "elementType":
REST API "string", 1103
Fortinet Inc. "nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
Get /policy/access-configuration/count/all

FortiNAC F 7.4.0 REST API 1104

Fortinet Inc.
Get /policy/access-configuration/direct-configuration

Get /policy/access-configuration/direct-configuration

Description

Returns whether or not direct configuration, a legacy concept, is allowed on the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/direct-configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1105

Fortinet Inc.
Get /policy/access-configuration/direct-configuration

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1106

Fortinet Inc.
Get /policy/access-configuration/{id}

Get /policy/access-configuration/{id}

Description

Returns a list of Access Configuration records matching the supplied filter.

Request Parameter

Id, the Access Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1107

Fortinet Inc.
Get /policy/access-configuration/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1108

Fortinet Inc.
Get /policy/access-configuration/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T23:31:56.110Z",
"id": 0,
"name": "quW/ODuLVsP)?%rW^@pjP<M",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:31:56.110Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:31:56.110Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
FortiNAC F 7.4.0 "elementType":
REST API "string", 1109
Fortinet Inc. "nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
Get /policy/access-configuration/{id}

FortiNAC F 7.4.0 REST API 1110

Fortinet Inc.
Get /policy/access-configuration/{id}/usage

Get /policy/access-configuration/{id}/usage

Description

Returns a list of records that reference this Access Configuration record.

Request Parameter

Id, the Access Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1111

Fortinet Inc.
Get /policy/access-configuration/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1112

Fortinet Inc.
Get /policy/access-configuration/supporting-info

Get /policy/access-configuration/supporting-info

Description

Returns the information necessary to create an Access Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access-

configuration/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1113

Fortinet Inc.
Get /policy/access-configuration/supporting-info

Sample Response

FortiNAC F 7.4.0 REST API 1114

Fortinet Inc.
Get /policy/access-configuration/supporting-info

{
"status": "string",
"errorMessage": "string",
"logicalNetworks": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T02:10:53.715Z",
"id": 0,
"name": "|@/,d./1UGtP&P{|%s0<<7wxja$<]g`E,~,n`55tS}@1>AvF
(i`$X'dbJ<^MYCtn5hO('u[h4|6]dtZg8'[>g)1X#LIW<W;\"",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T02:10:53.716Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T02:10:53.716Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"clis": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"eventTag": "string",
"taskType": "string",
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T02:10:53.716Z",
"lastChangeSummary": "string",
"message": "string",
"description": "string",
"removeMessage": "string",
"modifyAuditSummary": "string",
"name": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
FortiNAC F 7.4.0
}, REST API 1115
Fortinet Inc. "addAuditSummary": "string"
}
]
Get /policy/access-configuration/supporting-info

FortiNAC F 7.4.0 REST API 1116

Fortinet Inc.
Post /policy/access-configuration

Post /policy/access-configuration

Description

Creates a new Access Configuration record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/policy/access-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"id": 0,
"name": "@EreL010Vp'N~KJ_bJLAEQ
(X1c3N-.+TI4U1t6x%HExRVTZ)ycU<\\d$JX(c;eH;{8IqY&CM",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:37:55.143Z",
"dbid": 0,

FortiNAC F 7.4.0 REST API 1117

Fortinet Inc.
Post /policy/access-configuration

"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:37:55.143Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:37:55.143Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
"elementType": "string",
"nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
"taskType": "string",
"landscape": 0,
"id": 0,
"state": "string",
"version": 0
},
"logicalNetworkName": "string",
"accessActionStr": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [

FortiNAC F 7.4.0 REST API 1118

Fortinet Inc.
Post /policy/access-configuration

"string"
]
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1119

Fortinet Inc.
Post /policy/access-configuration/delete

Post /policy/access-configuration/delete

Description

Deletes a list of Access Configuration records supplied under the id parameter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access-

configuration/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 2

FortiNAC F 7.4.0 REST API 1120

Fortinet Inc.
Post /policy/access-configuration/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1121

Fortinet Inc.
Post /policy/access-configuration/{id}

Post /policy/access-configuration/{id}

Description

Updates an Access Configuration record.

Request Parameter

Id, the Access Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/policy/access-

configuration/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"id": 0,

FortiNAC F 7.4.0 REST API 1122

Fortinet Inc.
Post /policy/access-configuration/{id}

"name": "@EreL010Vp'N~KJ_bJLAEQ
(X1c3N-.+TI4U1t6x%HExRVTZ)ycU<\\d$JX(c;eH;{8IqY&CM",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-06T23:37:55.143Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-06T23:37:55.143Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-06T23:37:55.143Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
"elementType": "string",
"nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
"taskType": "string",
"landscape": 0,
"id": 0,
"state": "string",
"version": 0
},
"logicalNetworkName": "string",

FortiNAC F 7.4.0 REST API 1123

Fortinet Inc.
Post /policy/access-configuration/{id}

"accessActionStr": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1124

Fortinet Inc.
Post /policy/access-configuration/{id}/delete

Post /policy/access-configuration/{id}/delete

Description

Deletes a single Access Configuration record by ID.

Request Parameter

Id, the Access Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access-

configuration/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1125

Fortinet Inc.
Post /policy/access-configuration/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1126

Fortinet Inc.
Access Policy

Access Policy

FortiNAC F 7.4.0 REST API 1127

Fortinet Inc.
Delete /policy/access/{id}

Delete /policy/access/{id}

Description

Deletes a single Access Policy record by ID.

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/access/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1128

Fortinet Inc.
Delete /policy/access/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1129

Fortinet Inc.
Get /policy/access

Get /policy/access

Description

Returns a list of Access Policy records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1130

Fortinet Inc.
Get /policy/access

Sample Response

FortiNAC F 7.4.0 REST API 1131

Fortinet Inc.
Get /policy/access

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:17:31.732Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:17:31.732Z",
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:17:31.732Z",
"groupIDs": [
0
],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
FortiNAC F 7.4.0 "attributeFilters":
REST API { 1132
Fortinet Inc. "additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
Get /policy/access

FortiNAC F 7.4.0 REST API 1133

Fortinet Inc.
Post /policy/access/disable

Post /policy/access/disable

Description

Disables the supplied Access Policy

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

FortiNAC F 7.4.0 REST API 1134

Fortinet Inc.
Post /policy/access/disable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1135

Fortinet Inc.
Get /policy/access/{id}

Get /policy/access/{id}

Description

Returns a list of Access Policy records matching the supplied filter.

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1136

Fortinet Inc.
Get /policy/access/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1137

Fortinet Inc.
Get /policy/access/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:17:31.732Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:17:31.732Z",
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:17:31.732Z",
"groupIDs": [
0
],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
FortiNAC F 7.4.0 "attributeFilters":
REST API { 1138
Fortinet Inc. "additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
Get /policy/access/{id}

FortiNAC F 7.4.0 REST API 1139

Fortinet Inc.
Get /policy/access/supporting-info

Get /policy/access/supporting-info

Description

Returns the information necessary to create an Access Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/access/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1140

Fortinet Inc.
Get /policy/access/supporting-info

Sample Response

FortiNAC F 7.4.0 REST API 1141

Fortinet Inc.
Get /policy/access/supporting-info

{
"status": "string",
"errorMessage": "string",
"accessProfiles": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T22:54:59.468Z",
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T22:54:59.468Z",
"groupIDs": [
0
],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"methodTypeString": "string"
}
],
FortiNAC F 7.4.0 REST API
"locationNames": [ 1142
Fortinet Inc. "string"
]
}
Get /policy/access/supporting-info

FortiNAC F 7.4.0 REST API 1143

Fortinet Inc.
Post /policy/access

Post /policy/access

Description

Creates a new Access Policy record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:40:08.791Z",
"name": "string",
"note": "string",
"profile": {
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.791Z",
"groupIDs": [
0
],
"filterSet": [

FortiNAC F 7.4.0 REST API 1144

Fortinet Inc.
Post /policy/access

"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"methodTypeString": "string"
}
],
"locationNames": [
"string"
]
},
"configuration": {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,

FortiNAC F 7.4.0 REST API 1145

Fortinet Inc.
Post /policy/access

"alias": true,
"logicalNetwork": {
"id": 0,
"name": "G~ry|qYEtd
(@3peM;o8UD'sQ@O>+XIb>r\\D}VKKbh@sBCHrOuPc>4h*0M!)cxdC71vwRK?QSS'
[4sl-0aQd{[96;=H,>s8",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T19:40:08.792Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,
"task": {
"elementType": "string",
"nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
"taskType": "string",
"landscape": 0,
"id": 0,

FortiNAC F 7.4.0 REST API 1146

Fortinet Inc.
Post /policy/access

"state": "string",
"version": 0
},
"logicalNetworkName": "string",
"accessActionStr": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
},
"enabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T19:40:08.792Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"configurationName": "string"
}

FortiNAC F 7.4.0 REST API 1147

Fortinet Inc.
Post /policy/access

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1148

Fortinet Inc.
Post /policy/access/delete

Post /policy/access/delete

Description

Deletes a list of Access Policy records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1149

Fortinet Inc.
Post /policy/access/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1150

Fortinet Inc.
Post /policy/access/enable

Post /policy/access/enable

Description

Enables the supplied Access Policy

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

FortiNAC F 7.4.0 REST API 1151

Fortinet Inc.
Post /policy/access/enable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1152

Fortinet Inc.
Post /policy/access/{id}

Post /policy/access/{id}

Description

Updates an Access Policy record.

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T19:40:08.791Z",
"name": "string",
"note": "string",
"profile": {

FortiNAC F 7.4.0 REST API 1153

Fortinet Inc.
Post /policy/access/{id}

"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.791Z",
"groupIDs": [
0
],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"methodTypeString": "string"
}
],
"locationNames": [
"string"

FortiNAC F 7.4.0 REST API 1154

Fortinet Inc.
Post /policy/access/{id}

]
},
"configuration": {
"name": "string",
"note": "string",
"taskID": 0,
"access": "string",
"accessAction": 0,
"alias": true,
"logicalNetwork": {
"id": 0,
"name": "G~ry|qYEtd
(@3peM;o8UD'sQ@O>+XIb>r\\D}VKKbh@sBCHrOuPc>4h*0M!)cxdC71vwRK?QSS'
[4sl-0aQd{[96;=H,>s8",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T19:40:08.792Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"sendGroupsToFirewall": true,
"firewallGroups": [
0
],
"radiusAttributeGroupId": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"yamsEventTag": "string",
"accessValue": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"logicalNetworkID": 0,

FortiNAC F 7.4.0 REST API 1155

Fortinet Inc.
Post /policy/access/{id}

"task": {
"elementType": "string",
"nameTag": "string",
"eventTag": "string",
"scheduledObjectType": "string",
"taskType": "string",
"landscape": 0,
"id": 0,
"state": "string",
"version": 0
},
"logicalNetworkName": "string",
"accessActionStr": "string",
"id": 0,
"requestedTags": [
"string"
],
"tags": [
"string"
]
},
"enabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-07T19:40:08.792Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T19:40:08.792Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,

FortiNAC F 7.4.0 REST API 1156

Fortinet Inc.
Post /policy/access/{id}

"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"configurationName": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1157

Fortinet Inc.
Post /policy/access/{id}/delete

Post /policy/access/{id}/delete

Description

Deletes a single Access Policy record by ID.

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1158

Fortinet Inc.
Post /policy/access/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1159

Fortinet Inc.
Post /policy/access/{id}/disable

Post /policy/access/{id}/disable

Description

Disables the supplied Access Policy

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/2/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1160

Fortinet Inc.
Post /policy/access/{id}/disable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1161

Fortinet Inc.
Post /policy/access/{id}/enable

Post /policy/access/{id}/enable

Description

Enables the supplied Access Policy.

Request Parameter

Id, the Access Policy record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/2/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1162

Fortinet Inc.
Post /policy/access/{id}/enable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1163

Fortinet Inc.
Post /policy/access/rank/set

Post /policy/access/rank/set

Description

Sets the rank of the supplied Access Policy, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 2

rank: 1

FortiNAC F 7.4.0 REST API 1164

Fortinet Inc.
Post /policy/access/rank/set

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1165

Fortinet Inc.
Post /policy/access/rank/swap

Post /policy/access/rank/swap

Description

Swaps the rank position of the two supplied Access Policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/access/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 2

id2: 1

FortiNAC F 7.4.0 REST API 1166

Fortinet Inc.
Post /policy/access/rank/swap

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1167

Fortinet Inc.
Admin Profile

Admin Profile

FortiNAC F 7.4.0 REST API 1168

Fortinet Inc.
Delete /user/admin-profile/{id}

Delete /user/admin-profile/{id}

Description

Deletes a single Admin Profile record by ID.

Request Parameter

Id, the Admin Profile id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/admin-profile/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1169

Fortinet Inc.
Delete /user/admin-profile/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1170

Fortinet Inc.
Delete /user/admin-profile/mapping/{id}

Delete /user/admin-profile/mapping/{id}

Description

Deletes a single Admin Profile Mapping record by ID.

Request Parameter

Id, the Admin Profile Mapping Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1171

Fortinet Inc.
Delete /user/admin-profile/mapping/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1172

Fortinet Inc.
Get /user/admin-profile

Get /user/admin-profile

Description

Returns a list of Admin Profile records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1173

Fortinet Inc.
Get /user/admin-profile

Sample Response

FortiNAC F 7.4.0 REST API 1174

Fortinet Inc.
Get /user/admin-profile

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T19:29:01.374Z",
"administrator": true,
"isKioskMode": false,
"global": true,
"dbid": 0,
"name": "string",
"inactivityTime": 0,
"schedule": "string",
"kioskTemplateID": 0,
"kioskWelcomeMessage": "string",
"note": "string",
"landingPage": "string",
"manageByGroups": true,
"guid": 0,
"globalModifiedDate": "2024-03-06T19:29:01.374Z",
"preventAging": true,
"upgradePermissions": true,
"lockoutThreshold": 0,
"lockoutDuration": 0,
"permissions": {
"additionalProp1": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp2": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp3": {
"permissions": [
FortiNAC F 7.4.0 REST API
"string" 1175
Fortinet Inc. ],
"displayName_API": "string",
"view": true,
Get /user/admin-profile

FortiNAC F 7.4.0 REST API 1176

Fortinet Inc.
Get /user/admin-profile/{id}

Get /user/admin-profile/{id}

Description

Returns a list of Admin Profile matching both the ID passed as a parameter, and the supplied filter.

Request Parameter

Id, the Admin Profile id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-profile/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1177

Fortinet Inc.
Get /user/admin-profile/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1178

Fortinet Inc.
Get /user/admin-profile/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T19:29:01.374Z",
"administrator": true,
"isKioskMode": false,
"global": true,
"dbid": 0,
"name": "string",
"inactivityTime": 0,
"schedule": "string",
"kioskTemplateID": 0,
"kioskWelcomeMessage": "string",
"note": "string",
"landingPage": "string",
"manageByGroups": true,
"guid": 0,
"globalModifiedDate": "2024-03-06T19:29:01.374Z",
"preventAging": true,
"upgradePermissions": true,
"lockoutThreshold": 0,
"lockoutDuration": 0,
"permissions": {
"additionalProp1": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp2": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp3": {
"permissions": [
FortiNAC F 7.4.0 REST API
"string" 1179
Fortinet Inc. ],
"displayName_API": "string",
"view": true,
Get /user/admin-profile/{id}

FortiNAC F 7.4.0 REST API 1180

Fortinet Inc.
Get /user/admin-profile/{id}/usage

Get /user/admin-profile/{id}/usage

Description

Returns a list of records that reference this Admin Profile record by ID.

Request Parameter

Id, the Admin Profile id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-profile/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1181

Fortinet Inc.
Get /user/admin-profile/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1182

Fortinet Inc.
Get /user/admin-profile/mapping

Get /user/admin-profile/mapping

Description

Returns a list of Admin Profile Mapping records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-profile/mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1183

Fortinet Inc.
Get /user/admin-profile/mapping

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:42:56.210Z",
"adminProfileDBID": 0,
"groupDBID": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-05T23:42:56.210Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"groupName": "string",
"group": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:42:56.210Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T23:42:56.210Z",
"nameLabel": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1184

Fortinet Inc.
Get /user/admin-profile/mapping

FortiNAC F 7.4.0 REST API 1185

Fortinet Inc.
Get /user/admin-profile/mapping/{id}

Get /user/admin-profile/mapping/{id}

Description

Returns a list of Admin Profile Mapping records matching the supplied filter.

Request Parameter

Id, the Admin Profile Mapping Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1186

Fortinet Inc.
Get /user/admin-profile/mapping/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:42:56.210Z",
"adminProfileDBID": 0,
"groupDBID": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-05T23:42:56.210Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"groupName": "string",
"group": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:42:56.210Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T23:42:56.210Z",
"nameLabel": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1187

Fortinet Inc.
Get /user/admin-profile/mapping/{id}

FortiNAC F 7.4.0 REST API 1188

Fortinet Inc.
Get /user/admin-profile/mapping/supporting-info

Get /user/admin-profile/mapping/supporting-info

Description

Retrieves information necessary to create or modify an Admin Profile Mapping.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1189

Fortinet Inc.
Get /user/admin-profile/mapping/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"profiles": [
{
"id": 0,
"name": "string"
}
],
"groups": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1190

Fortinet Inc.
Get /user/admin-profile/new

Get /user/admin-profile/new

Description

Returns a new, empty Admin Profile that can be used to check the available permission sets.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-profile/new

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1191

Fortinet Inc.
Get /user/admin-profile/new

Sample Response

FortiNAC F 7.4.0 REST API 1192

Fortinet Inc.
Get /user/admin-profile/new

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-06T19:29:01.374Z",
"administrator": true,
"isKioskMode": false,
"global": true,
"dbid": 0,
"name": "string",
"inactivityTime": 0,
"schedule": "string",
"kioskTemplateID": 0,
"kioskWelcomeMessage": "string",
"note": "string",
"landingPage": "string",
"manageByGroups": true,
"guid": 0,
"globalModifiedDate": "2024-03-06T19:29:01.374Z",
"preventAging": true,
"upgradePermissions": true,
"lockoutThreshold": 0,
"lockoutDuration": 0,
"permissions": {
"additionalProp1": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp2": {
"permissions": [
"string"
],
"displayName_API": "string",
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp3": {
"permissions": [
FortiNAC F 7.4.0 REST API
"string" 1193
Fortinet Inc. ],
"displayName_API": "string",
"view": true,
Get /user/admin-profile/new

FortiNAC F 7.4.0 REST API 1194

Fortinet Inc.
Get /user/admin-profile/permission-view-map

Get /user/admin-profile/permission-view-map

Description

Returns a map of Permission Sets to Views

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/admin-

profile/permission-view-map

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1195

Fortinet Inc.
Get /user/admin-profile/permission-view-map

Sample Response

{
"status": "string",
"errorMessage": "string",
"viewMap": {
"additionalProp1": [
{}
],
"additionalProp2": [
{}
],
"additionalProp3": [
{}
]
},
"ncmViewMap": {
"additionalProp1": [
{}
],
"additionalProp2": [
{}
],
"additionalProp3": [
{}
]
}
}

FortiNAC F 7.4.0 REST API 1196

Fortinet Inc.
Post /user/admin-profile

Post /user/admin-profile

Description

Creates a new Admin Profile record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"isKioskMode": false,
"global": true,
"dbid": 0,
"name": "string",
"inactivityTime": 0,
"schedule": "string",
"kioskTemplateID": 0,
"kioskWelcomeMessage": "string",
"note": "string",
"landingPage": "string",
"manageByGroups": true,
"guid": 0,
"globalModifiedDate": "2024-03-06T19:39:19.699Z",
"preventAging": true,
"upgradePermissions": true,
"lockoutThreshold": 0,

FortiNAC F 7.4.0 REST API 1197

Fortinet Inc.
Post /user/admin-profile

"lockoutDuration": 0,
"permissions": {
"additionalProp1": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp2": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp3": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",

FortiNAC F 7.4.0 REST API 1198

Fortinet Inc.
Post /user/admin-profile

"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
}
},
"ncmLandingPage": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1199

Fortinet Inc.
Post /user/admin-profile/delete

Post /user/admin-profile/delete

Description

Deletes a list of Admin Profile records supplied by the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-profile/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1200

Fortinet Inc.
Post /user/admin-profile/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1201

Fortinet Inc.
Post /user/admin-profile/{id}

Post /user/admin-profile/{id}

Description

Updates an Admin Profile record with the supplied ID and values.

Request Parameter

Id, the Admin Profile id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-profile/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"isKioskMode": false,
"global": true,
"dbid": 1,
"name": "string",
"inactivityTime": 0,
"schedule": "string",
"kioskTemplateID": 0,
"kioskWelcomeMessage": "string",

FortiNAC F 7.4.0 REST API 1202

Fortinet Inc.
Post /user/admin-profile/{id}

"note": "string",
"landingPage": "string",
"manageByGroups": true,
"guid": 0,
"globalModifiedDate": "2024-03-06T19:39:19.699Z",
"preventAging": true,
"upgradePermissions": true,
"lockoutThreshold": 0,
"lockoutDuration": 0,
"permissions": {
"additionalProp1": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
},
"additionalProp2": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}

FortiNAC F 7.4.0 REST API 1203

Fortinet Inc.
Post /user/admin-profile/{id}

},
"additionalProp3": {
"permissions": [
"string"
],
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"view": true,
"modify": true,
"remove": true,
"customized": true,
"allIDs": true,
"selectedIDs": [
0
],
"allowedViews": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
}
},
"ncmLandingPage": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1204

Fortinet Inc.
Post /user/admin-profile/{id}/delete

Post /user/admin-profile/{id}/delete

Description

Deletes a single Admin Profile record by ID.

Request Parameter

Id, the Admin Profile id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1205

Fortinet Inc.
Post /user/admin-profile/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1206

Fortinet Inc.
Post /user/admin-profile/mapping

Post /user/admin-profile/mapping

Description

Creates a new Admin Profile Mapping record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:45:54.458Z",
"adminProfileDBID": 0,
"groupDBID": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},

FortiNAC F 7.4.0 REST API 1207

Fortinet Inc.
Post /user/admin-profile/mapping

"user": "string",
"action": "string",
"timestamp": "2024-03-05T23:45:54.458Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"groupName": "string",
"group": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T23:45:54.458Z",
"nameLabel": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1208

Fortinet Inc.
Post /user/admin-profile/mapping/delete

Post /user/admin-profile/mapping/delete

Description

Deletes a list of Admin Profile Mapping records supplied under the id parameter

Request Parameter

Id, the Admin Profile Mapping Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1209

Fortinet Inc.
Post /user/admin-profile/mapping/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1210

Fortinet Inc.
Post /user/admin-profile/mapping/{id}

Post /user/admin-profile/mapping/{id}

Description

Updates an Admin Profile Mapping record.

Request Parameter

Id, the Admin Profile Mapping Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T23:45:54.458Z",
"adminProfileDBID": 0,
"groupDBID": 0,
"auditObj": {

FortiNAC F 7.4.0 REST API 1211

Fortinet Inc.
Post /user/admin-profile/mapping/{id}

"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-05T23:45:54.458Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"groupName": "string",
"group": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T23:45:54.458Z",
"nameLabel": "string"
}
}

FortiNAC F 7.4.0 REST API 1212

Fortinet Inc.
Post /user/admin-profile/mapping/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1213

Fortinet Inc.
Post /user/admin-profile/mapping/rank/set

Post /user/admin-profile/mapping/rank/set

Description

Sets the rank of the supplied Admin Profile Mapping, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: xxx

rank: xx

FortiNAC F 7.4.0 REST API 1214

Fortinet Inc.
Post /user/admin-profile/mapping/rank/set

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1215

Fortinet Inc.
Post /user/admin-profile/mapping/rank/swap

Post /user/admin-profile/mapping/rank/swap

Description

Swaps the rank position of the two supplied Admin Profile Mappings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/admin-

profile/mapping/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: xxx

id2: xx

FortiNAC F 7.4.0 REST API 1216

Fortinet Inc.
Post /user/admin-profile/mapping/rank/swap

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1217

Fortinet Inc.
Agent Packages

Agent Packages

FortiNAC F 7.4.0 REST API 1218

Fortinet Inc.
Get /settings/agent/agent-packages

Get /settings/agent/agent-packages

Description

Returns the Agent Distribution Service.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/agent-

packages

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1219

Fortinet Inc.
Get /settings/agent/agent-packages

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"os": "string",
"size": "string",
"fileName": "string",
"packageName": "string",
"version": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1220

Fortinet Inc.
Get /settings/agent/agent-packages/available-agents

Get /settings/agent/agent-packages/available-agents

Description

Returns the List of available agents to download.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/agent-

packages/available-agents

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1221

Fortinet Inc.
Get /settings/agent/agent-packages/available-agents

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"hasNewAgents": true,
"downloadAgents": [
{
"name": "string",
"installed": true,
"isInstalled": true
}
]
}
}

FortiNAC F 7.4.0 REST API 1222

Fortinet Inc.
Post /settings/agent/agent-packages/{packageFile}/delete

Post /settings/agent/agent-packages/{packageFile}/delete

Description

Delete the agent package.

Request Parameter

packageFile, the agent package name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/agent-

packages/xxxxx/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1223

Fortinet Inc.
Post /settings/agent/agent-packages/{packageFile}/delete

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"updatePlatforms": [
"string"
],
"policies": [
{
"name": "string",
"agents": [
"string"
]
}
]
}
}

FortiNAC F 7.4.0 REST API 1224

Fortinet Inc.
Delete /settings/agent/agent-packages/{packageFile}

Delete /settings/agent/agent-packages/{packageFile}

Description

Delete the agent package.

Request Parameter

packageFile, the agent package name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/agent/agent-

packages/xxxxxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1225

Fortinet Inc.
Delete /settings/agent/agent-packages/{packageFile}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"updatePlatforms": [
"string"
],
"policies": [
{
"name": "string",
"agents": [
"string"
]
}
]
}
}

FortiNAC F 7.4.0 REST API 1226

Fortinet Inc.
Alarm

Alarm

FortiNAC F 7.4.0 REST API 1227

Fortinet Inc.
Get /logging/alarm

Get /logging/alarm

Description

Returns all Alarm records which match the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/alarm

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1228

Fortinet Inc.
Get /logging/alarm

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 2,
"state": 1,
"name": "DHCP_HOSTNAME_CHANGED",
"elementType": 8,
"elementID": 1991,
"elementName": "VMware, Inc.",
"severity": 3,
"timeOfAlarm": "2024-02-21T18:44:14.605+0000",
"timeAcknowledged": null,
"eventIDs": [
4732
],
"version": 1.3,
"numEventID": 1,
"time": 1708541054605,
"empty": false,
"triggerRuleType": {
"type": "Single",
"frequency": null,
"seconds": null,
"clearEventTag": null
},
"nameLabel": "DHCP Host Name Changed",
"probableCause": "The host name reported by DHCP for
00:50:56:B5:7B:EF has changed from S108DVLMX1GSDRCA
to S108DVJ0YUDNXV70.\nThe device may be configured
for dual boot or the\nphysical address may have been
cloned."
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 1229

Fortinet Inc.
Get /logging/alarm/count

Get /logging/alarm/count

Description

Returns a count of Alarm records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/alarm/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1230

Fortinet Inc.
Get /logging/alarm/count

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 2,
"state": 1,
"name": "DHCP_HOSTNAME_CHANGED",
"elementType": 8,
"elementID": 1991,
"elementName": "VMware, Inc.",
"severity": 3,
"timeOfAlarm": "2024-02-21T18:44:14.605+0000",
"timeAcknowledged": null,
"eventIDs": [
4732
],
"version": 1.3,
"numEventID": 1,
"time": 1708541054605,
"empty": false,
"triggerRuleType": {
"type": "Single",
"frequency": null,
"seconds": null,
"clearEventTag": null
},
"nameLabel": "DHCP Host Name Changed",
"probableCause": "The host name reported by DHCP for
00:50:56:B5:7B:EF has changed from S108DVLMX1GSDRCA
to S108DVJ0YUDNXV70.\nThe device may be configured
for dual boot or the\nphysical address may have been
cloned."
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 1231

Fortinet Inc.
Get /logging/alarm/count/all

Get /logging/alarm/count/all

Description

Return the count of all Alarm records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/alarm/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1232

Fortinet Inc.
Get /logging/alarm/count/all

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 2,
"state": 1,
"name": "DHCP_HOSTNAME_CHANGED",
"elementType": 8,
"elementID": 1991,
"elementName": "VMware, Inc.",
"severity": 3,
"timeOfAlarm": "2024-02-21T18:44:14.605+0000",
"timeAcknowledged": null,
"eventIDs": [
4732
],
"version": 1.3,
"numEventID": 1,
"time": 1708541054605,
"empty": false,
"triggerRuleType": {
"type": "Single",
"frequency": null,
"seconds": null,
"clearEventTag": null
},
"nameLabel": "DHCP Host Name Changed",
"probableCause": "The host name reported by DHCP for
00:50:56:B5:7B:EF has changed from S108DVLMX1GSDRCA
to S108DVJ0YUDNXV70.\nThe device may be configured
for dual boot or the\nphysical address may have been
cloned."
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 1233

Fortinet Inc.
Get /logging/alarm/archive

Get /logging/alarm/archive

Description

Returns the names of all alarm archives currently on the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/alarm/archive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1234

Fortinet Inc.
Get /logging/alarm/archive

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1235

Fortinet Inc.
Get /logging/alarm/archive/import/status

Get /logging/alarm/archive/import/status

Description

Returns the status of the most recent alarm archive import.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/host/logging/alarm/archive/import/status

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1236

Fortinet Inc.
Get /logging/alarm/archive/import/status

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": "string"
}

FortiNAC F 7.4.0 REST API 1237

Fortinet Inc.
Get /logging/alarm/{id}

Get /logging/alarm/{id}

Description

Returns the Alarm record with the supplied DBID

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/alarm/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1238

Fortinet Inc.
Get /logging/alarm/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 2,
"state": 1,
"name": "DHCP_HOSTNAME_CHANGED",
"elementType": 8,
"elementID": 1991,
"elementName": "VMware, Inc.",
"severity": 3,
"timeOfAlarm": "2024-02-21T18:44:14.605+0000",
"timeAcknowledged": null,
"eventIDs": [
4732
],
"version": 1.3,
"numEventID": 1,
"time": 1708541054605,
"empty": false,
"triggerRuleType": {
"type": "Single",
"frequency": null,
"seconds": null,
"clearEventTag": null
},
"nameLabel": "DHCP Host Name Changed",
"probableCause": "The host name reported by DHCP for
00:50:56:B5:7B:EF has changed from S108DVLMX1GSDRCA
to S108DVJ0YUDNXV70.\nThe device may be configured
for dual boot or the\nphysical address may have been
cloned."
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 1239

Fortinet Inc.
Get /logging/alarm/{id}/usage

Get /logging/alarm/{id}/usage

Description

Returns a list of records that reference this Alarm record.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/alarm/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1240

Fortinet Inc.
Get /logging/alarm/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]

FortiNAC F 7.4.0 REST API 1241

Fortinet Inc.
Get /logging/alarm/monitor/{id}

Get /logging/alarm/monitor/{id}

Description

Gets all changes to Alarm records since the Alarms were last polled.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/alarm/monitor/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1242

Fortinet Inc.
Get /logging/alarm/monitor/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-01T23:44:38.562Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"updated": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-01T23:44:38.562Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 1243

Fortinet Inc.
Get /logging/alarm/supporting-info

Get /logging/alarm/supporting-info

Description

Returns the information related to displaying alarms.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/alarm/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1244

Fortinet Inc.
Get /logging/alarm/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"alarmTypes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 1245

Fortinet Inc.
Post /logging/alarm/acknowledge

Post /logging/alarm/acknowledge

Description

Marks one or more alarms as Acknowledged, resolving any applied actions.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/acknowledge

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:3

FortiNAC F 7.4.0 REST API 1246

Fortinet Inc.
Post /logging/alarm/acknowledge

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1247

Fortinet Inc.
Post /logging/alarm/{id}/delete

Post /logging/alarm/{id}/delete

Description

Deletes the Alarm record supplied, if they are none are currently in use.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/alarm/delete/20

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1248

Fortinet Inc.
Post /logging/alarm/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1249

Fortinet Inc.
Post /logging/alarm/delete

Post /logging/alarm/delete

Description

Deletes the Alarm record or records supplied, if they are none are currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/alarm/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 20

FortiNAC F 7.4.0 REST API 1250

Fortinet Inc.
Post /logging/alarm/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1251

Fortinet Inc.
Post /logging/alarm/archive/import

Post /logging/alarm/archive/import

Description

Imports an alarm archive from the file system back into the database

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/archive/import

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request Body name:xxxxxxx

FortiNAC F 7.4.0 REST API 1252

Fortinet Inc.
Post /logging/alarm/archive/import

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1253

Fortinet Inc.
Post /logging/alarm/delete

Post /logging/alarm/delete

Description

Deletes the Alarm record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1254

Fortinet Inc.
Post /logging/alarm/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1255

Fortinet Inc.
Post /logging/alarm/{id}/acknowledge

Post /logging/alarm/{id}/acknowledge

Description

Marks an alarm as Acknowledged, resolving any applied actions.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/2/acknowledge

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1256

Fortinet Inc.
Post /logging/alarm/{id}/acknowledge

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1257

Fortinet Inc.
Post /logging/alarm/{id}/delete

Post /logging/alarm/{id}/delete

Description

Deletes the Alarm record or records supplied, if they are not currently in use.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/2/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1258

Fortinet Inc.
Post /logging/alarm/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1259

Fortinet Inc.
Post /logging/alarm/monitor/{id}/stop

Post /logging/alarm/monitor/{id}/stop

Description

Stops collecting changes made to Alarm records for the specified monitor.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/monitor/2/stop

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1260

Fortinet Inc.
Post /logging/alarm/monitor/{id}/stop

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1261

Fortinet Inc.
Post /logging/alarm/monitor/start

Post /logging/alarm/monitor/start

Description

Begins collecting changes made to Alarm records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/alarm/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1262

Fortinet Inc.
Post /logging/alarm/monitor/start

Sample Response

{
"status": "string",
"errorMessage": "string",
"total": 0,
"monitorID": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-01T23:41:05.114Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 1263

Fortinet Inc.
Delete /logging/alarm/{id}

Delete /logging/alarm/{id}

Description

Deletes the alarm record supplied, if it is not currently in use.

Request Parameter

Id, the Alarm record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/logging/alarm/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1264

Fortinet Inc.
Delete /logging/alarm/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1265

Fortinet Inc.
Audit Log

Audit Log

FortiNAC F 7.4.0 REST API 1266

Fortinet Inc.
Get /logging/audit

Get /logging/audit

Description

Returns all of the matching audit logs. Includes a hash of DBID to name mappings per record type.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/audit

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1267

Fortinet Inc.
Get /logging/audit

Sample Response

{
"status": "string",
"errorMessage": "string",
"nameCache": {
"additionalProp1": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"additionalProp2": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"additionalProp3": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"results": [
{
"recordID": 0,
"date": "2024-03-02T01:05:51.764Z",
"recordName": "string",
"userID": "string",
"summary": "string",
"recordType": "string",
"action": "string",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-02T01:05:51.764Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1268

Fortinet Inc.
Get /logging/audit/count

Get /logging/audit/count

Description

Returns a count of the total number of audit logs

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/audit/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1269

Fortinet Inc.
Get /logging/audit/count

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": "string"
}

FortiNAC F 7.4.0 REST API 1270

Fortinet Inc.
Backup Configuration

Backup Configuration

FortiNAC F 7.4.0 REST API 1271

Fortinet Inc.
Get /system/backup/configuration/ftp

Get /system/backup/configuration/ftp

Description

Returns the FTP remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup/configuration/ftp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1272

Fortinet Inc.
Get /system/backup/configuration/ftp

Sample Response

{
"status": "string",
"errorMessage": "string",
"host": "string",
"user": "string",
"path": "string"
}

FortiNAC F 7.4.0 REST API 1273

Fortinet Inc.
Get /system/backup/configuration/sftp

Get /system/backup/configuration/sftp

Description

Returns the SFTP remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup/configuration/sftp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1274

Fortinet Inc.
Get /system/backup/configuration/sftp

Sample Response

{
"status": "string",
"errorMessage": "string",
"host": "string",
"path": "string"
}

FortiNAC F 7.4.0 REST API 1275

Fortinet Inc.
Get /system/backup/configuration/ssh

Get /system/backup/configuration/ssh

Description

Returns the SSH remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup/configuration/ssh

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1276

Fortinet Inc.
Get /system/backup/configuration/ssh

Sample Response

{
"status": "string",
"errorMessage": "string",
"host": "string",
"path": "string"
}

FortiNAC F 7.4.0 REST API 1277

Fortinet Inc.
Post /system/backup/configuration/ftp

Post /system/backup/configuration/ftp

Description

Returns the FTP remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup/configuration/ftp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"host": "string",
"user": "string",
"path": "string",
"password": "string"
}

FortiNAC F 7.4.0 REST API 1278

Fortinet Inc.
Post /system/backup/configuration/ftp

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1279

Fortinet Inc.
Post /system/backup/configuration/sftp

Post /system/backup/configuration/sftp

Description

Returns the SFTP remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup/configuration/sftp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"host": "string",
"path": "string"
}

FortiNAC F 7.4.0 REST API 1280

Fortinet Inc.
Post /system/backup/configuration/sftp

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1281

Fortinet Inc.
Post /system/backup/configuration/ssh

Post /system/backup/configuration/ssh

Description

Returns the SSH remote backup configuration settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup/configuration/ssh

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"host": "string",
"path": "string"
}

FortiNAC F 7.4.0 REST API 1282

Fortinet Inc.
Post /system/backup/configuration/ssh

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1283

Fortinet Inc.
Backup Settings

Backup Settings

FortiNAC F 7.4.0 REST API 1284

Fortinet Inc.
Get /system/backup-settings/archives

Get /system/backup-settings/archives

Description

Returns the currently configured database archive settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup-

settings/archives

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1285

Fortinet Inc.
Get /system/backup-settings/archives

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"dbArchiveBackupDays": "string",
"evtAlarmAgeTime": "string",
"scanResultsAgeTime": "string",
"connectionAgeTime": "string"
}
}

FortiNAC F 7.4.0 REST API 1286

Fortinet Inc.
Get /system/backup-settings/database

Get /system/backup-settings/database

Description

Returns the currently configured database backup settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup-

settings/database

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1287

Fortinet Inc.
Get /system/backup-settings/database

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"archiveName": "string",
"backupDays": "string"
}
}

FortiNAC F 7.4.0 REST API 1288

Fortinet Inc.
Get /system/backup-settings/database/archive

Get /system/backup-settings/database/archive

Description

Returns a list of available local backups.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup-

settings/database/archive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1289

Fortinet Inc.
Get /system/backup-settings/database/archive

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1290

Fortinet Inc.
Get /system/backup-settings/system-backup

Get /system/backup-settings/system-backup

Description

Returns the currently configured system backup settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/backup-

settings/system-backup

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1291

Fortinet Inc.
Get /system/backup-settings/system-backup

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"systemBackupDays": "string"
}
}

FortiNAC F 7.4.0 REST API 1292

Fortinet Inc.
Post /system/backup-settings/archives

Post /system/backup-settings/archives

Description

Add Database Archive settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

dbArchiveBackupDays Yes String

evtAlarmAgeTime Yes String

scanResultsAgeTime Yes String

connectionAgeTime Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup-

settings/archives

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1293

Fortinet Inc.
Post /system/backup-settings/archives

Request Body dbArchiveBackupDays: "xxxxxxxx"

evtAlarmAgeTime: "xxxxxxxx"
scanResultsAgeTime: "xxxxxxxx"
connectionAgeTime: "xxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1294

Fortinet Inc.
Post /system/backup-settings/database

Post /system/backup-settings/database

Description

Sets the Database backup settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

archiveName Yes String

backupDays Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup-

settings/archives

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body archiveName: "xxxxx"

backupDays: "xxxxxx"

FortiNAC F 7.4.0 REST API 1295

Fortinet Inc.
Post /system/backup-settings/database

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1296

Fortinet Inc.
Post /system/backup-settings/database/restore-archives

Post /system/backup-settings/database/restore-archives

Description

Restore the Database Archives.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

archiveName Yes String

backupDays Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup-

settings/database/restore-archives

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body archiveName: "xxxxx"

backupDays: "xxxxxx"

FortiNAC F 7.4.0 REST API 1297

Fortinet Inc.
Post /system/backup-settings/database/restore-archives

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": "string
}

FortiNAC F 7.4.0 REST API 1298

Fortinet Inc.
Post /system/backup-settings/system-backup

Post /system/backup-settings/system-backup

Description

Sets the System Backup settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

systemBackupDays Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/backup-

settings/system-backup

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body systemBackupDays: "xxxxxxx"

FortiNAC F 7.4.0 REST API 1299

Fortinet Inc.
Post /system/backup-settings/system-backup

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1300

Fortinet Inc.
Device Profiling Rule

Device Profiling Rule

FortiNAC F 7.4.0 REST API 1301

Fortinet Inc.
Get /host/device-profiling-rule

Get /host/device-profiling-rule

Description

Returns all Device Profiling Rule records which match the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-rule

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1302

Fortinet Inc.
Get /host/device-profiling-rule

Sample Response

FortiNAC F 7.4.0 REST API 1303

Fortinet Inc.
Get /host/device-profiling-rule

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
FortiNAC F 7.4.0 "disable":
REST API true, 1304
Fortinet Inc. "version": 0
},
"lastModifiedBy": "string",
Get /host/device-profiling-rule

FortiNAC F 7.4.0 REST API 1305

Fortinet Inc.
Get /host/device-profiling-rule/count

Get /host/device-profiling-rule/count

Description

Returns the count of all Device Profiling Rule records in the database that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1306

Fortinet Inc.
Get /host/device-profiling-rule/count

Sample Response

FortiNAC F 7.4.0 REST API 1307

Fortinet Inc.
Get /host/device-profiling-rule/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
FortiNAC F 7.4.0 "disable":
REST API true, 1308
Fortinet Inc. "version": 0
},
"lastModifiedBy": "string",
Get /host/device-profiling-rule/count

FortiNAC F 7.4.0 REST API 1309

Fortinet Inc.
Get /host/device-profiling-rule/count/all

Get /host/device-profiling-rule/count/all

Description

Returns the count of all Device Profiling Rule records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1310

Fortinet Inc.
Get /host/device-profiling-rule/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1311

Fortinet Inc.
Get /host/device-profiling-rule/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
FortiNAC F 7.4.0 "disable":
REST API true, 1312
Fortinet Inc. "version": 0
},
"lastModifiedBy": "string",
Get /host/device-profiling-rule/count/all

FortiNAC F 7.4.0 REST API 1313

Fortinet Inc.
Get /host/device-profiling-rule/create-from-adapter

Get /host/device-profiling-rule/create-from-adapter

Description

Returns the potential contents of a new Device Profiling Rule created from an existing adapter. This is not automatically
added to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

macAddress Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/create-from-adapter

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body macAddress: xxxxxxxxx

FortiNAC F 7.4.0 REST API 1314

Fortinet Inc.
Get /host/device-profiling-rule/create-from-adapter

Sample Response

FortiNAC F 7.4.0 REST API 1315

Fortinet Inc.
Get /host/device-profiling-rule/create-from-adapter

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
FortiNAC F 7.4.0 "disable":
REST API true, 1316
Fortinet Inc. "version": 0
},
"lastModifiedBy": "string",
Get /host/device-profiling-rule/create-from-adapter

FortiNAC F 7.4.0 REST API 1317

Fortinet Inc.
Get /host/device-profiling-rule/{id}

Get /host/device-profiling-rule/{id}

Description

Returns all Device Profiling Rule records with the supplied DBID.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1318

Fortinet Inc.
Get /host/device-profiling-rule/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1319

Fortinet Inc.
Get /host/device-profiling-rule/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 1,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
FortiNAC F 7.4.0 "disable":
REST API true, 1320
Fortinet Inc. "version": 0
},
"lastModifiedBy": "string",
Get /host/device-profiling-rule/{id}

FortiNAC F 7.4.0 REST API 1321

Fortinet Inc.
Get /host/device-profiling-rule/queue

Get /host/device-profiling-rule/queue

Description

Returns the number of MAC addresses currently queued to be profiled.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/queue

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1322

Fortinet Inc.
Get /host/device-profiling-rule/queue

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0
}

FortiNAC F 7.4.0 REST API 1323

Fortinet Inc.
Post /host/device-profiling-rule

Post /host/device-profiling-rule

Description

Adds a new Device Profiling Rule record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0
},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,

FortiNAC F 7.4.0 REST API 1324

Fortinet Inc.
Post /host/device-profiling-rule

"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
"disable": true,
"version": 0
},
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-28T19:25:46.868Z",
"guid": 0,
"globalModifiedDate": "2024-02-28T19:25:46.868Z",
"registerToUser": "string",
"tags": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",

FortiNAC F 7.4.0 REST API 1325

Fortinet Inc.
Post /host/device-profiling-rule

"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"catchAll": true,
"methodSummaryString": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1326

Fortinet Inc.
Post /host/device-profiling-rule/delete

Post /host/device-profiling-rule/delete

Description

Deletes the Device Profiling Rule record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1327

Fortinet Inc.
Post /host/device-profiling-rule/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1328

Fortinet Inc.
Post /host/device-profiling-rule/{id}

Post /host/device-profiling-rule/{id}

Description

Updates an existing Device Profiling Rule record in the database.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 3,
"name": "string",
"type": {
"name": "string",
"tag": "string",
"imageFile": "string",
"id": 0

FortiNAC F 7.4.0 REST API 1329

Fortinet Inc.
Post /host/device-profiling-rule/{id}

},
"notify": true,
"registerAutomatically": true,
"registerClient": true,
"registerToLoggedInUser": true,
"role": "string",
"addToGroup": true,
"groupId": 0,
"addToDomain": true,
"domainId": 0,
"state": "string",
"version": 0,
"rank": 0,
"enabled": true,
"methods": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"methodTypeString": "string"
}
],
"description": "string",
"sponsorNote": "string",
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"reValidation": true,
"reValidationInterval": 0,
"failedValidationAction": {
"disable": true,
"version": 0
},
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-28T19:25:46.868Z",
"guid": 0,
"globalModifiedDate": "2024-02-28T19:25:46.868Z",
"registerToUser": "string",

FortiNAC F 7.4.0 REST API 1330

Fortinet Inc.
Post /host/device-profiling-rule/{id}

"tags": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"catchAll": true,
"methodSummaryString": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1331

Fortinet Inc.
Post /host/device-profiling-rule/{id}/delete

Post /host/device-profiling-rule/{id}/delete

Description

Deletes the Device Profiling Rule record or records supplied, if they are not currently in use.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1332

Fortinet Inc.
Post /host/device-profiling-rule/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1333

Fortinet Inc.
Post /host/device-profiling-rule/{id}/disable

Post /host/device-profiling-rule/{id}/disable

Description

Disables the Device Profiling Rule that matches the supplied DBID.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/9/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1334

Fortinet Inc.
Post /host/device-profiling-rule/{id}/disable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1335

Fortinet Inc.
Post /host/device-profiling-rule/{id}/enable

Post /host/device-profiling-rule/{id}/enable

Description

Enables the Device Profiling Rule that matches the supplied DBID.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/9/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1336

Fortinet Inc.
Post /host/device-profiling-rule/{id}/enable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1337

Fortinet Inc.
Get /host/device-profiling-rule/{id}/usage

Get /host/device-profiling-rule/{id}/usage

Description

Returns a list of Device Profiling Rule records that reference this record.

Request Parameter

Id, Device Profiling Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1338

Fortinet Inc.
Get /host/device-profiling-rule/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string"
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1339

Fortinet Inc.
Post /host/device-profiling-rule/scan

Post /host/device-profiling-rule/scan

Description

Queues all unprofiled rogues to be scanned for matching Device Profiling Rules.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1340

Fortinet Inc.
Post /host/device-profiling-rule/scan

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0
}

FortiNAC F 7.4.0 REST API 1341

Fortinet Inc.
Post /host/device-profiling-rule/swap-rule-ranks

Post /host/device-profiling-rule/swap-rule-ranks

Description

Swaps the ranks of two Device Profiling Rules with provided database ids.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/swap-rule-ranks

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 6

id2: 3

FortiNAC F 7.4.0 REST API 1342

Fortinet Inc.
Post /host/device-profiling-rule/swap-rule-ranks

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1343

Fortinet Inc.
Post /host/device-profiling-rule/test

Post /host/device-profiling-rule/test

Description

Tests to see if the Device Profiling Rule with the supplied name would match the supplied adapter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ruleName Required String

macAddress Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ruleName: 6

macAddress: xxxxxxxxxx

FortiNAC F 7.4.0 REST API 1344

Fortinet Inc.
Post /host/device-profiling-rule/test

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": true
}

FortiNAC F 7.4.0 REST API 1345

Fortinet Inc.
Delete /host/device-profiling-rule/{id}

Delete /host/device-profiling-rule/{id}

Description

Deletes the Device Profiling Rule record supplied, if it is not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/device-profiling-

rule/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1346

Fortinet Inc.
Delete /host/device-profiling-rule/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1347

Fortinet Inc.
Device Type

Device Type

FortiNAC F 7.4.0 REST API 1348

Fortinet Inc.
Delete /settings/device/device-type/{id}

Delete /settings/device/device-type/{id}

Description

Deletes a single Device Type record by ID

Request Parameter

Id, the Device Type record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/device/device-

type/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1349

Fortinet Inc.
Delete /settings/device/device-type/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1350

Fortinet Inc.
Get /settings/device/device-type

Get /settings/device/device-type

Description

Returns a list of Device Type records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/device-type

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1351

Fortinet Inc.
Get /settings/device/device-type

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T23:02:14.998Z",
"dbid": 0,
"name": "string",
"tag": "string",
"defaultType": true,
"guid": 0,
"globalModifiedDate": "2024-03-
12T23:02:14.998Z",
"smallIcon": "string",
"largeIcon": "string",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T23:02:14.998Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1352

Fortinet Inc.
Get /settings/device/device-type/{id}

Get /settings/device/device-type/{id}

Description

Returns a list of Device Type records matching the supplied filter

Request Parameter

Id, the Device Type record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/device-

type/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1353

Fortinet Inc.
Get /settings/device/device-type/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T23:02:14.998Z",
"dbid": 0,
"name": "string",
"tag": "string",
"defaultType": true,
"guid": 0,
"globalModifiedDate": "2024-03-
12T23:02:14.998Z",
"smallIcon": "string",
"largeIcon": "string",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T23:02:14.998Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1354

Fortinet Inc.
Get /settings/device/device-type/{id}/usage

Get /settings/device/device-type/{id}/usage

Description

Returns a list of records that reference this Device Type record.

Request Parameter

Id, the Device Type record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/device-

type/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1355

Fortinet Inc.
Get /settings/device/device-type/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1356

Fortinet Inc.
Get /settings/device/device-type/image/archive

Get /settings/device/device-type/image/archive

Description

Returns the images currently uploaded to the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/device-

type/image/archive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1357

Fortinet Inc.
Get /settings/device/device-type/image/archive

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"filename": "string",
"getxOffset": 0,
"getyOffset": 0
}
]
}

FortiNAC F 7.4.0 REST API 1358

Fortinet Inc.
Post /settings/device/device-type

Post /settings/device/device-type

Description

Creates a new Device Type record, updating instead if the supplied profile has a DBID of one that already exists

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-type

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"tag": "string",
"defaultType": true,
"guid": 0,
"globalModifiedDate": "2024-03-12T23:07:18.646Z",
"smallIcon": "string",
"largeIcon": "string",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",

FortiNAC F 7.4.0 REST API 1359

Fortinet Inc.
Post /settings/device/device-type

"action": "string",
"timestamp": "2024-03-12T23:07:18.646Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1360

Fortinet Inc.
Post /settings/device/device-type/createFromArchive

Post /settings/device/device-type/createFromArchive

Description

Creates a new Device Type record, and assigns it an image from the image archive.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Yes String

imageName Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-

type/createFromArchive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "xxxxxxx"

imageName: "xxxxxxx"

FortiNAC F 7.4.0 REST API 1361

Fortinet Inc.
Post /settings/device/device-type/createFromArchive

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1362

Fortinet Inc.
Post /settings/device/device-type/delete

Post /settings/device/device-type/delete

Description

Deletes a list of Device Type records supplied under the id parameter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-

type/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 8

FortiNAC F 7.4.0 REST API 1363

Fortinet Inc.
Post /settings/device/device-type/delete

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1364

Fortinet Inc.
Post /settings/device/device-type/{id}

Post /settings/device/device-type/{id}

Description

Updates an Device Type Device Type record.

Request Parameter

Id, the Device Type record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-

type/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"tag": "string",
"defaultType": true,
"guid": 0,
"globalModifiedDate": "2024-03-12T23:07:18.646Z",
"smallIcon": "string",
"largeIcon": "string",

FortiNAC F 7.4.0 REST API 1365

Fortinet Inc.
Post /settings/device/device-type/{id}

"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T23:07:18.646Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1366

Fortinet Inc.
Post /settings/device/device-type/{id}/delete

Post /settings/device/device-type/{id}/delete

Description

Deletes a single Device Type record by ID.

Request Parameter

Id, the Device Type record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/device-

type/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1367

Fortinet Inc.
Post /settings/device/device-type/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1368

Fortinet Inc.
Email

Email

FortiNAC F 7.4.0 REST API 1369

Fortinet Inc.
Get /settings/integration/email

Get /settings/integration/email

Description

Returns the currently configured e-mail server settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/email

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1370

Fortinet Inc.
Get /settings/integration/email

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"smtpTimeout": 0,
"smtpConnectionTimeout": 0,
"emailPassword": "string",
"emailAuthType": "string",
"emailPort": "string",
"emailUsername": "string",
"emailServer": "string",
"emailAuth": "string",
"emailSender": "string",
"alwaysSendAsSender": true
}
}

FortiNAC F 7.4.0 REST API 1371

Fortinet Inc.
Get /settings/integration/email/password

Get /settings/integration/email/password

Description

Returns the password for the currently configured e-mail server. This is done separately so that passwords may be
restricted..

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/email/password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1372

Fortinet Inc.
Get /settings/integration/email/password

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1373

Fortinet Inc.
Post /settings/integration/email

Post /settings/integration/email

Description

Sets the e-mail server settings for this appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

smtpTimeout Required Integer

smtpConnectionTimeout Required Integer

emailPassword Required String

emailAuthType Required String

emailPort Required String

emailUsername Required String

emailServer Required String

emailAuth Required String

emailSender Required String

alwaysSendAsSender Required Boolean

FortiNAC F 7.4.0 REST API 1374

Fortinet Inc.
Post /settings/integration/email

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/email

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body smtpTimeout: xx

smtpConnectionTimeout: xx
emailPassword: "xxxxxxxxxx"
emailAuthType: "xxxxxxxxxx"
emailPort: "xxxxxxxxxx"
emailUsername: "xxxxxxxxxx"
emailServer: "xxxxxxxxxx"
emailAuth: "xxxxxxxxxx"
emailSender: "xxxxxxxxxx"
alwaysSendAsSender: TRUE

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1375

Fortinet Inc.
Post /settings/integration/email/delete

Post /settings/integration/email/delete

Description

Resets the e-mail server settings for this appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/email/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1376

Fortinet Inc.
Post /settings/integration/email/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1377

Fortinet Inc.
Post /settings/integration/email/test

Post /settings/integration/email/test

Description

Sends a test e-mail to the supplied address, either using the current settings or those supplied in this request.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

smtpTimeout Required Integer

smtpConnectionTimeout Required Integer

emailPassword Required String

emailAuthType Required String

emailPort Required String

emailUsername Required String

emailServer Required String

emailAuth Required String

emailSender Required String

alwaysSendAsSender Required Boolean

email Required String

recipient Required String

FortiNAC F 7.4.0 REST API 1378

Fortinet Inc.
Post /settings/integration/email/test

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/email/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body smtpTimeout: xx

smtpConnectionTimeout: xx
emailPassword: "xxxxxxxxxx"
emailAuthType: "xxxxxxxxxx"
emailPort: "xxxxxxxxxx"
emailUsername: "xxxxxxxxxx"
emailServer: "xxxxxxxxxx"
emailAuth: "xxxxxxxxxx"
emailSender: "xxxxxxxxxx"
alwaysSendAsSender: TRUE
email: "xxxxxxxxxx"
recipient: "xxxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1379

Fortinet Inc.
Endpoint Compliance Configuration

Endpoint Compliance Configuration

FortiNAC F 7.4.0 REST API 1380

Fortinet Inc.
Delete /policy/endpoint-compliance-configuration/{id}

Delete /policy/endpoint-compliance-configuration/{id}

Description

Deletes a single Endpoint Compliance Configuration record by ID

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1381

Fortinet Inc.
Delete /policy/endpoint-compliance-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": 0
}

FortiNAC F 7.4.0 REST API 1382

Fortinet Inc.
Get /policy/endpoint-compliance-configuration

Get /policy/endpoint-compliance-configuration

Description

Returns a list of Endpoint Compliance Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1383

Fortinet Inc.
Get /policy/endpoint-compliance-configuration

Sample Response

FortiNAC F 7.4.0 REST API 1384

Fortinet Inc.
Get /policy/endpoint-compliance-configuration

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Virus Can",
"note": "",
"agents": {
"WINDOWS_CE": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"OPENBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"SOLARIS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"Mac-OS-X": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"Windows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"Any": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPAD": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"RIM_TABLET_OS": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"CHROME_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"WINDOWS_RT": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"FREEBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"KINDLE": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPOD": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"LINUX_OTHER": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"WEBOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"Linux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"BLACKBERRY_10": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"LINUX_x86": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPHONE": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"NETBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"SYMBIAN": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"ANDROID": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",
"BLACKBERRY_OS": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"WINDOWS_PHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950"
},
"actions": {},
"profileID": 2,
"scriptProfile": {
"lastModifiedBy": "",
"lastModifiedDate": "1970-01-01T00:00:00.000+0000",
"lastChangeSummary": "",
"name": "OS-Anti-Virus-Check",
"guid": -1,
"globalModifiedDate": "1970-01-01T00:00:00.000+0000",
"scriptType": 0,
"entityType": 7,
"groupID": -1,
"id": 2,
"state": 0,
"renewIP": false,
"scanRogue": true,
"registerFailedRogue": false,
"scanOnConnect": false,
"auditOnly": false,
"elapsedNumberOfDays": 0,
FortiNAC F 7.4.0 "jailbreakThreshold":
REST API -1, 1385
Fortinet Inc. "rootThreshold": -1,
"auditObjectName": "OS-Anti-Virus-Check",
"auditObjectType": {
Get /policy/endpoint-compliance-configuration

FortiNAC F 7.4.0 REST API 1386

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/{id}

Get /policy/endpoint-compliance-configuration/{id}

Description

Returns a list of Endpoint Compliance Configuration records matching the supplied filter.

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1387

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1388

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Virus Can",
"note": "",
"agents": {
"WINDOWS_CE": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"OPENBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"SOLARIS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"Mac-OS-X": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"Windows": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"Any": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPAD": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"RIM_TABLET_OS": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"CHROME_OS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"WINDOWS_RT": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"FREEBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"KINDLE": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPOD": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"LINUX_OTHER": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"WEBOS": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"Linux": "b8a94e0a-91b9-4f83-9fba-601b04d8fe20",
"BLACKBERRY_10": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"LINUX_x86": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"APPLE_IOS_IPHONE": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"NETBSD": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"SYMBIAN": "3255ea97-14ad-432a-b2b4-fa4332aba950",
"ANDROID": "dee7da73-46cd-40b1-8bbf-b39ca0bc1b5e",
"BLACKBERRY_OS": "3255ea97-14ad-432a-b2b4-
fa4332aba950",
"WINDOWS_PHONE": "3255ea97-14ad-432a-b2b4-fa4332aba950"
},
"actions": {},
"profileID": 2,
"scriptProfile": {
"lastModifiedBy": "",
"lastModifiedDate": "1970-01-01T00:00:00.000+0000",
"lastChangeSummary": "",
"name": "OS-Anti-Virus-Check",
"guid": -1,
"globalModifiedDate": "1970-01-01T00:00:00.000+0000",
"scriptType": 0,
"entityType": 7,
"groupID": -1,
"id": 2,
"state": 0,
"renewIP": false,
"scanRogue": true,
"registerFailedRogue": false,
"scanOnConnect": false,
"auditOnly": false,
"elapsedNumberOfDays": 0,
FortiNAC F 7.4.0 "jailbreakThreshold":
REST API -1, 1389
Fortinet Inc. "rootThreshold": -1,
"auditObjectName": "OS-Anti-Virus-Check",
"auditObjectType": {
Get /policy/endpoint-compliance-configuration/{id}

FortiNAC F 7.4.0 REST API 1390

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/{id}/usage

Get /policy/endpoint-compliance-configuration/{id}/usage

Description

Returns a list of records that reference this Endpoint Compliance Configuration record.

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1391

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1392

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/supporting-info

Get /policy/endpoint-compliance-configuration/supporting-
info

Description

Returns the information used to create an Endpoint Compliance Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1393

Fortinet Inc.
Get /policy/endpoint-compliance-configuration/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"policies": [
{
"id": 0,
"name": "string"
}
],
"commonAgent": [
{
"version": "string",
"name": "string",
"filename": "string",
"outputFileName": "string",
"appStoreURL": "string",
"platform": "Windows",
"configEncrypted": true,
"offset": 0,
"minServerVersion": "string",
"fileSize": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vendors": [
"string"
],
"type": "DISSOLVABLE"
}
],
"otherAgent": [
{
"version": "string",
"name": "string",
"filename": "string",
"outputFileName": "string",
"appStoreURL": "string",
"platform": "Windows",
"configEncrypted": true,
"offset": 0,
"minServerVersion": "string",
"fileSize": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vendors": [
"string"
],
"type": "DISSOLVABLE"
}
]
}

FortiNAC F 7.4.0 REST API 1394

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

Post /policy/endpoint-compliance-configuration

Description

Creates a new Endpoint Compliance Configuration record, updating instead if the supplied profile has a DBID of one
that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 1395

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"agents": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"actions": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profileID": 0,
"scriptProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T23:29:27.568Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,

FortiNAC F 7.4.0 REST API 1396

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"appCollectionEnabled": true,
"agentAndroid": "string",
"agentIOSUnknown": "string",
"agentIOSIPad": "string",
"agentIOSIPhone": "string",
"agentIOSIPod": "string",
"agentLinux": "string",
"agentMacOSX": "string",
"agentWindows": "string",
"allowedBSSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"nameLabel": "string"
},
"allowedESSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"nameLabel": "string"
},

FortiNAC F 7.4.0 REST API 1397

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

"multihomeDetectionEnabled": true,
"legacyActionsEnabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"scanName": "string",
"agentSettings": {
"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eventActions": {
"additionalProp1": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"

FortiNAC F 7.4.0 REST API 1398

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp2": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {

FortiNAC F 7.4.0 REST API 1399

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp3": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,

FortiNAC F 7.4.0 REST API 1400

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
},
"eventActionIDs": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T23:29:27.568Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",

FortiNAC F 7.4.0 REST API 1401

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"id": 0
}

FortiNAC F 7.4.0 REST API 1402

Fortinet Inc.
Post /policy/endpoint-compliance-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"results": 0
}

FortiNAC F 7.4.0 REST API 1403

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/delete

Post /policy/endpoint-compliance-configuration/delete

Description

Deletes a list of Endpoint Compliance Configuration records supplied under the id parameter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1404

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1405

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

Post /policy/endpoint-compliance-configuration/{id}

Description

Updates an Endpoint Compliance Configuration record

Request Parameter

Id, the Endpoint Compliance Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"agents": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"actions": {

FortiNAC F 7.4.0 REST API 1406

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profileID": 0,
"scriptProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T23:29:27.568Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,

FortiNAC F 7.4.0 REST API 1407

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"appCollectionEnabled": true,
"agentAndroid": "string",
"agentIOSUnknown": "string",
"agentIOSIPad": "string",
"agentIOSIPhone": "string",
"agentIOSIPod": "string",
"agentLinux": "string",
"agentMacOSX": "string",
"agentWindows": "string",
"allowedBSSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"nameLabel": "string"
},
"allowedESSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"nameLabel": "string"
},
"multihomeDetectionEnabled": true,
"legacyActionsEnabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",

FortiNAC F 7.4.0 REST API 1408

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"scanName": "string",
"agentSettings": {
"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eventActions": {
"additionalProp1": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],

FortiNAC F 7.4.0 REST API 1409

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp2": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"

FortiNAC F 7.4.0 REST API 1410

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp3": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",

FortiNAC F 7.4.0 REST API 1411

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-07T23:29:27.568Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
},
"eventActionIDs": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-07T23:29:27.568Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-07T23:29:27.568Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,

FortiNAC F 7.4.0 REST API 1412

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"id": 0
}

FortiNAC F 7.4.0 REST API 1413

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": 0
}

FortiNAC F 7.4.0 REST API 1414

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}/delete

Post /policy/endpoint-compliance-configuration/{id}/delete

Description

Deletes a single Endpoint Compliance Configuration record by ID

Request Parameter

Id, the Endpoint Compliance Configuration record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance-configuration/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1415

Fortinet Inc.
Post /policy/endpoint-compliance-configuration/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1416

Fortinet Inc.
Endpoint Compliance Policy

Endpoint Compliance Policy

FortiNAC F 7.4.0 REST API 1417

Fortinet Inc.
Delete /policy/endpoint-compliance/{id}

Delete /policy/endpoint-compliance/{id}

Description

Deletes a single Endpoint Compliance Policy record by ID.

Request Parameter

Id, the Endpoint Compliance Policy Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1418

Fortinet Inc.
Delete /policy/endpoint-compliance/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1419

Fortinet Inc.
Get /policy/endpoint-compliance

Get /policy/endpoint-compliance

Description

Returns a list of Endpoint Compliance Policy records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-compliance

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1420

Fortinet Inc.
Get /policy/endpoint-compliance

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1421

Fortinet Inc.
Get /policy/endpoint-compliance/{id}

Get /policy/endpoint-compliance/{id}

Description

Returns a list of Endpoint Compliance Policy records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1422

Fortinet Inc.
Get /policy/endpoint-compliance/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1423

Fortinet Inc.
Get /policy/endpoint-compliance/supporting-info

Get /policy/endpoint-compliance/supporting-info

Description

Returns the information used to create an Endpoint Compliance Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1424

Fortinet Inc.
Get /policy/endpoint-compliance/supporting-info

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1425

Fortinet Inc.
Post /policy/endpoint-compliance

Post /policy/endpoint-compliance

Description

Creates a new Endpoint Compliance Policy record, updating instead if the supplied profile has a DBID of one that
already exists

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.356Z",
"name": "string",
"note": "string",
"profile": {
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.356Z",
"groupIDs": [
0

FortiNAC F 7.4.0 REST API 1426

Fortinet Inc.
Post /policy/endpoint-compliance

],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"methodTypeString": "string"
}
],
"locationNames": [
"string"
]
},
"configuration": {
"name": "string",
"note": "string",
"agents": {

FortiNAC F 7.4.0 REST API 1427

Fortinet Inc.
Post /policy/endpoint-compliance

"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"actions": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profileID": 0,
"scriptProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.357Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",

FortiNAC F 7.4.0 REST API 1428

Fortinet Inc.
Post /policy/endpoint-compliance

"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"appCollectionEnabled": true,
"agentAndroid": "string",
"agentIOSUnknown": "string",
"agentIOSIPad": "string",
"agentIOSIPhone": "string",
"agentIOSIPod": "string",
"agentLinux": "string",
"agentMacOSX": "string",
"agentWindows": "string",
"allowedBSSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"nameLabel": "string"
},
"allowedESSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"nameLabel": "string"
},
"multihomeDetectionEnabled": true,
"legacyActionsEnabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,

FortiNAC F 7.4.0 REST API 1429

Fortinet Inc.
Post /policy/endpoint-compliance

"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"scanName": "string",
"agentSettings": {
"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eventActions": {
"additionalProp1": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},

FortiNAC F 7.4.0 REST API 1430

Fortinet Inc.
Post /policy/endpoint-compliance

"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp2": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",

FortiNAC F 7.4.0 REST API 1431

Fortinet Inc.
Post /policy/endpoint-compliance

"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp3": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",

FortiNAC F 7.4.0 REST API 1432

Fortinet Inc.
Post /policy/endpoint-compliance

"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
},
"eventActionIDs": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.357Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,

FortiNAC F 7.4.0 REST API 1433

Fortinet Inc.
Post /policy/endpoint-compliance

"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"id": 0
},
"enabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},

FortiNAC F 7.4.0 REST API 1434

Fortinet Inc.
Post /policy/endpoint-compliance

"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"configurationName": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1435

Fortinet Inc.
Post /policy/endpoint-compliance/delete

Post /policy/endpoint-compliance/delete

Description

Deletes a list of Endpoint Compliance Policy records supplied under the id parameter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1436

Fortinet Inc.
Post /policy/endpoint-compliance/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1437

Fortinet Inc.
Post /policy/endpoint-compliance/disable

Post /policy/endpoint-compliance/disable

Description

Disables the supplied Endpoint Compliance Policy

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 1438

Fortinet Inc.
Post /policy/endpoint-compliance/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1439

Fortinet Inc.
Post /policy/endpoint-compliance/enable

Post /policy/endpoint-compliance/enable

Description

Enables the supplied Endpoint Compliance Policy

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 1440

Fortinet Inc.
Post /policy/endpoint-compliance/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1441

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

Post /policy/endpoint-compliance/{id}

Description

Updates an Endpoint Compliance Policy record

Request Parameter

Id, the Endpoint Compliance Policy Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.356Z",
"name": "string",
"note": "string",
"profile": {

FortiNAC F 7.4.0 REST API 1442

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.356Z",
"groupIDs": [
0
],
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"catchAll": true,
"locationIDs": [
0
],
"dbid": 0,
"locationOperator": "OR",
"groupOperator": "OR",
"groupNames": [
"string"
],
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"methodTypeString": "string"
}
],
"locationNames": [
"string"

FortiNAC F 7.4.0 REST API 1443

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

]
},
"configuration": {
"name": "string",
"note": "string",
"agents": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"actions": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profileID": 0,
"scriptProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.357Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",

FortiNAC F 7.4.0 REST API 1444

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"appCollectionEnabled": true,
"agentAndroid": "string",
"agentIOSUnknown": "string",
"agentIOSIPad": "string",
"agentIOSIPhone": "string",
"agentIOSIPod": "string",
"agentLinux": "string",
"agentMacOSX": "string",
"agentWindows": "string",
"allowedBSSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"nameLabel": "string"
},
"allowedESSIDGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"nameLabel": "string"
},
"multihomeDetectionEnabled": true,

FortiNAC F 7.4.0 REST API 1445

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"legacyActionsEnabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"scanName": "string",
"agentSettings": {
"additionalProp1": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"additionalProp3": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"eventActions": {
"additionalProp1": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},

FortiNAC F 7.4.0 REST API 1446

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp2": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",

FortiNAC F 7.4.0 REST API 1447

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"additionalProp3": {
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,

FortiNAC F 7.4.0 REST API 1448

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"typeDescription": "string",
"auditString": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
},
"eventActionIDs": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-08T22:58:01.357Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,

FortiNAC F 7.4.0 REST API 1449

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
},
"id": 0
},
"enabled": true,
"guid": 0,
"globalModifiedDate": "2024-03-08T22:58:01.357Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},

FortiNAC F 7.4.0 REST API 1450

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

"user": "string",
"action": "string",
"timestamp": "2024-03-08T22:58:01.357Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"filterSet": [
"string"
],
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"configurationName": "string"
}

FortiNAC F 7.4.0 REST API 1451

Fortinet Inc.
Post /policy/endpoint-compliance/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1452

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/delete

Post /policy/endpoint-compliance/{id}/delete

Description

Deletes a single Endpoint Compliance Policy record by ID.

Request Parameter

Id, the Endpoint Compliance Policy Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1453

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1454

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/disable

Post /policy/endpoint-compliance/{id}/disable

Description

Disables the supplied Endpoint Compliance Policy.

Request Parameter

Id, the Endpoint Compliance Policy Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/7/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1455

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1456

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/enable

Post /policy/endpoint-compliance/{id}/enable

Description

Enables the supplied Endpoint Compliance Policy.

Request Parameter

Id, the Endpoint Compliance Policy Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/7/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1457

Fortinet Inc.
Post /policy/endpoint-compliance/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1458

Fortinet Inc.
Post /policy/endpoint-compliance/rank/set

Post /policy/endpoint-compliance/rank/set

Description

Sets the rank of the supplied Endpoint Compliance Policy, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

rank Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1459

Fortinet Inc.
Post /policy/endpoint-compliance/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1460

Fortinet Inc.
Post /policy/endpoint-compliance/rank/swap

Post /policy/endpoint-compliance/rank/swap

Description

Swaps the rank position of the two supplied Endpoint Compliance Policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Required Integer

id2 Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 2

id2: 4

FortiNAC F 7.4.0 REST API 1461

Fortinet Inc.
Post /policy/endpoint-compliance/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1462

Fortinet Inc.
Endpoint Compliance Scan

Endpoint Compliance Scan

FortiNAC F 7.4.0 REST API 1463

Fortinet Inc.
Delete /policy/endpoint-compliance/scan/{id}

Delete /policy/endpoint-compliance/scan/{id}

Description

Deletes a single Endpoint Compliance Scan by ID, if it is not currently in use

Request Parameter

Id, the Scan Result record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1464

Fortinet Inc.
Delete /policy/endpoint-compliance/scan/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1465

Fortinet Inc.
Get /policy/endpoint-compliance/scan

Get /policy/endpoint-compliance/scan

Description

Returns all Scan Result records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1466

Fortinet Inc.
Get /policy/endpoint-compliance/scan

Sample Response

FortiNAC F 7.4.0 REST API 1467

Fortinet Inc.
Get /policy/endpoint-compliance/scan

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T19:42:32.695Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T19:42:32.695Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1468

Fortinet Inc.
Get /policy/endpoint-compliance/scan/available

Get /policy/endpoint-compliance/scan/available

Description

Returns the full set of tests and custom scans available for each operating system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/available

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1469

Fortinet Inc.
Get /policy/endpoint-compliance/scan/available

Sample Response

FortiNAC F 7.4.0 REST API 1470

Fortinet Inc.
Get /policy/endpoint-compliance/scan/available

{
"status": "string",
"errorMessage": "string",
"result": {
"osDetails": {
"additionalProp1": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp2": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
FortiNAC F 7.4.0 REST
} API 1471
Fortinet Inc. ]
},
"additionalProp3": {
Get /policy/endpoint-compliance/scan/count

Get /policy/endpoint-compliance/scan/count

Description

Gets a count of Scan Results that match the provided filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1472

Fortinet Inc.
Get /policy/endpoint-compliance/scan/count

Sample Response

FortiNAC F 7.4.0 REST API 1473

Fortinet Inc.
Get /policy/endpoint-compliance/scan/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T19:42:32.695Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T19:42:32.695Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1474

Fortinet Inc.
Get /policy/endpoint-compliance/scan/count/all

Get /policy/endpoint-compliance/scan/count/all

Description

Returns the count of all Scan Results in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1475

Fortinet Inc.
Get /policy/endpoint-compliance/scan/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1476

Fortinet Inc.
Get /policy/endpoint-compliance/scan/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T19:42:32.695Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T19:42:32.695Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1477

Fortinet Inc.
Get /policy/endpoint-compliance/scan/details

Get /policy/endpoint-compliance/scan/details

Description

Returns the selected tests and monitors for the Endpoint Compliance Scan.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

policyName Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body policyName: "xxxxxxxxx"

FortiNAC F 7.4.0 REST API 1478

Fortinet Inc.
Get /policy/endpoint-compliance/scan/details

Sample Response

FortiNAC F 7.4.0 REST API 1479

Fortinet Inc.
Get /policy/endpoint-compliance/scan/details

{
"status": "string",
"errorMessage": "string",
"result": {
"osDetails": {
"additionalProp1": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp2": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
FortiNAC F 7.4.0 REST
} API 1480
Fortinet Inc. ]
},
"additionalProp3": {
Get /policy/endpoint-compliance/scan/{id}

Get /policy/endpoint-compliance/scan/{id}

Description

Returns the Scan Result record that matches the supplied DBID.

Request Parameter

Id, the Scan Result record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1481

Fortinet Inc.
Get /policy/endpoint-compliance/scan/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1482

Fortinet Inc.
Get /policy/endpoint-compliance/scan/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T19:42:32.695Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T19:42:32.695Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1483

Fortinet Inc.
Get /policy/endpoint-compliance/scan/{id}/usage

Get /policy/endpoint-compliance/scan/{id}/usage

Description

Returns a list of records that reference this Endpoint Compliance Scan by ID.

Request Parameter

Id, the Scan Result record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1484

Fortinet Inc.
Get /policy/endpoint-compliance/scan/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1485

Fortinet Inc.
Get /policy/endpoint-compliance/scan/product

Get /policy/endpoint-compliance/scan/product

Description

Returns the details used to display and edit a product within the policy. Each product supplies its own markup and
scripts that may be used to create a valid configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

policyName Optional String

productName Required String

osName Required String

familyName Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/product

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1486

Fortinet Inc.
Get /policy/endpoint-compliance/scan/product

Request Body productName: "xxxxxxx"

osName: "xxxxxxxx"
familyName: "xxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string",
"html": "string",
"script": "string",
"scans": [
"string"
]
}

FortiNAC F 7.4.0 REST API 1487

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}/details

Post /policy/endpoint-compliance/scan/{id}/details

Description

Sets the selected tests and monitors for the Endpoint Compliance Scan.

Request Parameter

Id, the Scan Result record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/3/scan/details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"osDetails": {
"additionalProp1": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [

FortiNAC F 7.4.0 REST API 1488

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}/details

{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp2": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp3": {
"name": "string",
"families": [
{

FortiNAC F 7.4.0 REST API 1489

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}/details

"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
}
}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1490

Fortinet Inc.
Post /policy/endpoint-compliance/scan/remove-policy-types

Post /policy/endpoint-compliance/scan/remove-policy-
types

Description

Removes endpoint compliance policy objects for the supplied policy name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "xxxxxxx"

FortiNAC F 7.4.0 REST API 1491

Fortinet Inc.
Post /policy/endpoint-compliance/scan/remove-policy-types

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1492

Fortinet Inc.
Post /policy/endpoint-compliance/scan

Post /policy/endpoint-compliance/scan

Description

Creates a new Endpoint Compliance Scan record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T22:36:42.303Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T22:36:42.303Z",
"scriptType": "string",
"entityType": "string",
"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",

FortiNAC F 7.4.0 REST API 1493

Fortinet Inc.
Post /policy/endpoint-compliance/scan

"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
}

FortiNAC F 7.4.0 REST API 1494

Fortinet Inc.
Post /policy/endpoint-compliance/scan

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1495

Fortinet Inc.
Post /policy/endpoint-compliance/scan/copy

Post /policy/endpoint-compliance/scan/copy

Description

Copies all content from the supplied Scan to a new Scan.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

policyName Required String

newPolicyName Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body policyName: "xxxxxxx"

newPolicyName: "xxxxxxxx"

FortiNAC F 7.4.0 REST API 1496

Fortinet Inc.
Post /policy/endpoint-compliance/scan/copy

Sample Response

{
"status": "string",
"errorMessage": "string",
"html": "string",
"script": "string",
"scans": [
"string"
]
}

FortiNAC F 7.4.0 REST API 1497

Fortinet Inc.
Post /policy/endpoint-compliance/scan/delete

Post /policy/endpoint-compliance/scan/delete

Description

Deletes a list of Endpoint Compliance Scans supplied under the ID parameter, if they are not currently in use

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1498

Fortinet Inc.
Post /policy/endpoint-compliance/scan/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1499

Fortinet Inc.
Post /policy/endpoint-compliance/scan/details

Post /policy/endpoint-compliance/scan/details

Description

Sets the selected tests and monitors for the Endpoint Compliance Scan

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"osDetails": {
"additionalProp1": {
"name": "string",
"families": [
{

FortiNAC F 7.4.0 REST API 1500

Fortinet Inc.
Post /policy/endpoint-compliance/scan/details

"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp2": {
"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
},
"additionalProp3": {

FortiNAC F 7.4.0 REST API 1501

Fortinet Inc.
Post /policy/endpoint-compliance/scan/details

"name": "string",
"families": [
{
"name": "string",
"preferredProduct": "string",
"selProducts": [
{
"name": "string",
"customSettings": "string"
}
],
"lOp": "string"
}
],
"monitors": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"scans": [
{
"type": "string",
"scans": [
"string"
]
}
]
}
}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1502

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}

Post /policy/endpoint-compliance/scan/{id}

Description

Updates an existing Endpoint Compliance Scan.

Request Parameter

Id, the Scan Result record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-11T22:36:42.303Z",
"lastChangeSummary": "string",
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-03-11T22:36:42.303Z",
"scriptType": "string",
"entityType": "string",

FortiNAC F 7.4.0 REST API 1503

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}

"groupID": 0,
"linkUp": true,
"patchURL": "string",
"id": 0,
"state": "string",
"portGroupName": "string",
"deviceGroupName": "string",
"patchInformation": "string",
"defaultPolicy": true,
"registrationPolicy": true,
"remediationPolicy": true,
"agentPolicy": true,
"vpnPolicy": true,
"renewIP": true,
"scanRogue": true,
"registerFailedRogue": true,
"groupName": "string",
"bypassedOperatingSystems": [
{}
],
"persistenAgentRequired": [
{}
],
"scanOnConnect": true,
"label": "string",
"auditOnly": true,
"elapsedNumberOfDays": 0,
"jailbreakThreshold": 0,
"rootThreshold": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"directoryAttrVal": "string",
"policyHash": 0,
"timeToWait": 0,
"securityElement": 0,
"allAgentUUIDs": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"epcmodifyAuditSummary": true,
"otherModifyAuditSummary": true
}

FortiNAC F 7.4.0 REST API 1504

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1505

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}/delete

Post /policy/endpoint-compliance/scan/{id}/delete

Description

Deletes a single Endpoint Compliance Scan by ID, if it is not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/endpoint-

compliance/scan/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1506

Fortinet Inc.
Post /policy/endpoint-compliance/scan/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1507

Fortinet Inc.
Event

Event

FortiNAC F 7.4.0 REST API 1508

Fortinet Inc.
Delete /logging/event/{id}

Delete /logging/event/{id}

Description

Deletes the event record that matches the supplied DBID, if it is not currently in use.

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/host/logging/event/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1509

Fortinet Inc.
Delete /logging/event/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1510

Fortinet Inc.
Get /logging/event

Get /logging/event

Description

Returns all event records which match the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1511

Fortinet Inc.
Get /logging/event

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-02T01:09:25.372Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1512

Fortinet Inc.
Get /logging/event/archive

Get /logging/event/archive

Description

Returns the event archives currently stored on the filesystem.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/archive

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1513

Fortinet Inc.
Get /logging/event/archive

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
"string"
]
}

FortiNAC F 7.4.0 REST API 1514

Fortinet Inc.
Get /logging/event/archive/import/status

Get /logging/event/archive/import/status

Description

Returns the status of the most recent event archive import.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/host/logging/event/archive/import/status

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1515

Fortinet Inc.
Get /logging/event/archive/import/status

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 1516

Fortinet Inc.
Get /logging/event/count

Get /logging/event/count

Description

Returns a count of all event records that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1517

Fortinet Inc.
Get /logging/event/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-02T01:17:46.787Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1518

Fortinet Inc.
Get /logging/event/count/all

Get /logging/event/count/all

Description

Returns a count of all event records that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1519

Fortinet Inc.
Get /logging/event/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-02T01:19:27.925Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1520

Fortinet Inc.
Get /logging/event/{id}

Get /logging/event/{id}

Description

Returns the event record that matched the supplied DBID.

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1521

Fortinet Inc.
Get /logging/event/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-02T01:19:27.925Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1522

Fortinet Inc.
Get /logging/event/{id}/usage

Get /logging/event/{id}/usage

Description

Returns a list of records that reference this event record

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/4/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1523

Fortinet Inc.
Get /logging/event/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1524

Fortinet Inc.
Get /logging/event/monitor/{id}

Get /logging/event/monitor/{id}

Description

Gets all changes to event records since the Events were last polled.

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/monitor/7

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1525

Fortinet Inc.
Get /logging/event/monitor/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-04T18:30:51.974Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
],
"updated": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-04T18:30:51.974Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 1526

Fortinet Inc.
Get /logging/event/supporting-info

Get /logging/event/supporting-info

Description

Returns a list of all supported event types.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1527

Fortinet Inc.
Get /logging/event/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"first": "string",
"second": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1528

Fortinet Inc.
Post /logging/event

Post /logging/event

Description

Adds a new event record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-02T01:11:09.499Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
}

FortiNAC F 7.4.0 REST API 1529

Fortinet Inc.
Post /logging/event

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1530

Fortinet Inc.
Post /logging/event/archive/import

Post /logging/event/archive/import

Description

Imports an event archive from filesystem back into the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

fileName Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/archive/import

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request Body fileName: xxxxxxx

FortiNAC F 7.4.0 REST API 1531

Fortinet Inc.
Post /logging/event/archive/import

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1532

Fortinet Inc.
Post /logging/event/delete

Post /logging/event/delete

Description

Deletes the event record or records that match the supplied DBID(s), if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 1533

Fortinet Inc.
Post /logging/event/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1534

Fortinet Inc.
Post /logging/event/{id}

Post /logging/event/{id}

Description

Updates an existing event record in the database.

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",

FortiNAC F 7.4.0 REST API 1535

Fortinet Inc.
Post /logging/event/{id}

"timeOfEvent": "2024-03-02T01:23:13.247Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1536

Fortinet Inc.
Post /logging/event/{id}/delete

Post /logging/event/{id}/delete

Description

Deletes the event record that matches the supplied DBID, if it is not currently in use

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/4/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1537

Fortinet Inc.
Post /logging/event/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1538

Fortinet Inc.
Post /logging/event/monitor/start

Post /logging/event/monitor/start

Description

Begins collecting changes made to event records matching the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1539

Fortinet Inc.
Post /logging/event/monitor/start

Sample Response

{
"status": "string",
"errorMessage": "string",
"total": 0,
"monitorID": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-04T18:18:07.572Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
}
]
}

FortiNAC F 7.4.0 REST API 1540

Fortinet Inc.
Post /logging/event/monitor/{id}/stop

Post /logging/event/monitor/{id}/stop

Description

Stops collecting changes made to event records for the specified monitor.

Request Parameter

Id, the event record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/monitor/5/stop

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1541

Fortinet Inc.
Post /logging/event/monitor/{id}/stop

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1542

Fortinet Inc.
Post /logging/event/note

Post /logging/event/note

Description

Sets the note for one or more events.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

note Yes String

id Yes Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event/note

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

note: "xxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 1543

Fortinet Inc.
Post /logging/event/note

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1544

Fortinet Inc.
Event To Alarm Mapping

Event To Alarm Mapping

FortiNAC F 7.4.0 REST API 1545

Fortinet Inc.
Delete /logging/event-alarm-mapping/{id}

Delete /logging/event-alarm-mapping/{id}

Description

Deletes the event to alarm mapping record that matches the supplied id, if it is not currently in use.

Request Parameters

Id, the event alarm mapping record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/count/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1546

Fortinet Inc.
Delete /logging/event-alarm-mapping/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1547

Fortinet Inc.
Get /logging/event-alarm-mapping

Get /logging/event-alarm-mapping

Description

Returns all event to alarm mapping records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1548

Fortinet Inc.
Get /logging/event-alarm-mapping

Sample Response

FortiNAC F 7.4.0 REST API 1549

Fortinet Inc.
Get /logging/event-alarm-mapping

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",
"elementID": 0,
"notifyGroupID": 0,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
FortiNAC F 7.4.0 "accessPolicy":
REST API 0, 1550
Fortinet Inc. "daysValid": 0,
"daysInactive": 0,
"guid": 0,
Get /logging/event-alarm-mapping

FortiNAC F 7.4.0 REST API 1551

Fortinet Inc.
Get /logging/event-alarm-mapping/count/all

Get /logging/event-alarm-mapping/count/all

Description

Returns the count of all event to alarm mapping records in the database

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1552

Fortinet Inc.
Get /logging/event-alarm-mapping/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1553

Fortinet Inc.
Get /logging/event-alarm-mapping/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",
"elementID": 0,
"notifyGroupID": 0,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
FortiNAC F 7.4.0 "accessPolicy":
REST API 0, 1554
Fortinet Inc. "daysValid": 0,
"daysInactive": 0,
"guid": 0,
Get /logging/event-alarm-mapping/count/all

FortiNAC F 7.4.0 REST API 1555

Fortinet Inc.
Get /logging/event-alarm-mapping/count

Get /logging/event-alarm-mapping/count

Description

Returns the count of all event to alarm mapping records that match the provided filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1556

Fortinet Inc.
Get /logging/event-alarm-mapping/count

Sample Response

FortiNAC F 7.4.0 REST API 1557

Fortinet Inc.
Get /logging/event-alarm-mapping/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",
"elementID": 0,
"notifyGroupID": 0,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
FortiNAC F 7.4.0 "accessPolicy":
REST API 0, 1558
Fortinet Inc. "daysValid": 0,
"daysInactive": 0,
"guid": 0,
Get /logging/event-alarm-mapping/count

FortiNAC F 7.4.0 REST API 1559

Fortinet Inc.
Get /logging/event-alarm-mapping/{id}

Get /logging/event-alarm-mapping/{id}

Description

Returns the event to alarm mapping record that matches the supplied DBID

Request Parameters

Id, the event alarm mapping record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/count/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1560

Fortinet Inc.
Get /logging/event-alarm-mapping/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1561

Fortinet Inc.
Get /logging/event-alarm-mapping/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",
"elementID": 0,
"notifyGroupID": 0,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T00:28:19.831Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
FortiNAC F 7.4.0 "accessPolicy":
REST API 0, 1562
Fortinet Inc. "daysValid": 0,
"daysInactive": 0,
"guid": 0,
Get /logging/event-alarm-mapping/{id}

FortiNAC F 7.4.0 REST API 1563

Fortinet Inc.
Get /logging/event-alarm-mapping/{id}/usage

Get /logging/event-alarm-mapping/{id}/usage

Description

Returns a list of records that reference this event to alarm mapping record.

Request Parameters

Id, the event alarm mapping record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1564

Fortinet Inc.
Get /logging/event-alarm-mapping/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1565

Fortinet Inc.
Get /logging/event-alarm-mapping/supporting-info

Get /logging/event-alarm-mapping/supporting-info

Description

Returns information needed to create an Event to Alarm mapping, such as the list of possible events.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1566

Fortinet Inc.
Get /logging/event-alarm-mapping/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"scans": [
"string"
],
"roles": [
{
"id": 0,
"name": "string"
}
],
"eventTypes": [
{
"landscape": 0,
"id": 0,
"state": "string",
"eventTag": "string",
"elementType": "string",
"alarmTag": "string",
"version": 0,
"systemOnly": true,
"ncm": true,
"groupID": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T22:15:22.502Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string"
}
],
"clis": [
"string"
],
"groups": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1567

Fortinet Inc.
Post /logging/event-alarm-mapping

Post /logging/event-alarm-mapping

Description

Returns all event to alarm mapping records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",
"elementID": 0,
"notifyGroupID": 0,
"sendEmail": true,
"sendSMS": true,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {

FortiNAC F 7.4.0 REST API 1568

Fortinet Inc.
Post /logging/event-alarm-mapping

"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"log": true,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T19:07:59.034Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T19:07:59.034Z",
"nameLabel": "string"
},
"rule": {
"satisfiedByTime": true,
"type": "string",
"name": "string",
"version": 0
},
"elementTypeAuditType": {

FortiNAC F 7.4.0 REST API 1569

Fortinet Inc.
Post /logging/event-alarm-mapping

"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1570

Fortinet Inc.
Post /logging/event-alarm-mapping/delete

Post /logging/event-alarm-mapping/delete

Description

Deletes the event to alarm mapping record or records matching the supplied id(s), if they are none are currently in use

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array<Integar>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1571

Fortinet Inc.
Post /logging/event-alarm-mapping/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1572

Fortinet Inc.
Post /logging/event-alarm-mapping/disable

Post /logging/event-alarm-mapping/disable

Description

Disables the supplied event to alarm mapping.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array<Integar>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 5

FortiNAC F 7.4.0 REST API 1573

Fortinet Inc.
Post /logging/event-alarm-mapping/disable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1574

Fortinet Inc.
Post /logging/event-alarm-mapping/enable

Post /logging/event-alarm-mapping/enable

Description

Enables the supplied event to alarm mapping.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array<Integar>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 1575

Fortinet Inc.
Post /logging/event-alarm-mapping/enable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1576

Fortinet Inc.
Post /logging/event-alarm-mapping/{id}

Post /logging/event-alarm-mapping/{id}

Description

Updates an existing event to alarm mapping record in the database

Request Parameters

Id, the event alarm mapping record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"alarmName": "string",
"eventName": "string",
"clearEventName": "string",
"severity": 0,
"elementType": "string",

FortiNAC F 7.4.0 REST API 1577

Fortinet Inc.
Post /logging/event-alarm-mapping/{id}

"elementID": 0,
"notifyGroupID": 0,
"sendEmail": true,
"sendSMS": true,
"alarmAction": {
"emailMessage": "string",
"valuesForDiff": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"primaryTask": {
"emailMessage": "string",
"name": "string"
},
"secondaryTask": {
"emailMessage": "string",
"name": "string"
},
"duration": 0,
"clearTask": {
"emailMessage": "string",
"name": "string"
},
"message": "string",
"name": "string"
},
"paused": true,
"version": 0,
"log": true,
"scriptName": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T19:07:59.034Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string",
"notifyGroup": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-05T19:07:59.034Z",
"nameLabel": "string"
},

FortiNAC F 7.4.0 REST API 1578

Fortinet Inc.
Post /logging/event-alarm-mapping/{id}

"rule": {
"satisfiedByTime": true,
"type": "string",
"name": "string",
"version": 0
},
"elementTypeAuditType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1579

Fortinet Inc.
Post /logging/event-alarm-mapping/{id}/delete

Post /logging/event-alarm-mapping/{id}/delete

Description

Deletes the event to alarm mapping record that matches the supplied id, if it is not currently in use.

Request Parameters

Id, the event alarm mapping record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1580

Fortinet Inc.
Post /logging/event-alarm-mapping/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1581

Fortinet Inc.
Post /logging/event-alarm-mapping/modify

Post /logging/event-alarm-mapping/modify

Description

Sets common configuration values for several Event to Alarm Mappings in a single request.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

severity Required Integer

notifyGroupID Required Integer

notifyByEmail Required Boolean

notifyBySMS Required Boolean

ids Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/logging/event-alarm-

mapping/modify

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1582

Fortinet Inc.
Post /logging/event-alarm-mapping/modify

Request Body severity: "xxxxxxxxx"

notifyGroupID: "xxxxx"
notifyByEmailL "xxxxxxxxxxx"
notifyBySMS: "xxxxxxxxxxxxx"
ids: "xx"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1583

Fortinet Inc.
Event Types

Event Types

FortiNAC F 7.4.0 REST API 1584

Fortinet Inc.
Get /logging/event-types

Get /logging/event-types

Description

Returns all Event Type records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event-types

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1585

Fortinet Inc.
Get /logging/event-types

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"eventTag": "string",
"elementType": "string",
"alarmTag": "string",
"version": 0,
"systemOnly": true,
"ncm": true,
"groupID": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T22:29:34.028Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1586

Fortinet Inc.
Get /logging/event-types/count

Get /logging/event-types/count

Description

Returns the count of all Event Type records that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event-

types/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1587

Fortinet Inc.
Get /logging/event-types/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"eventTag": "string",
"elementType": "string",
"alarmTag": "string",
"version": 0,
"systemOnly": true,
"ncm": true,
"groupID": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T22:29:34.028Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1588

Fortinet Inc.
Get /logging/event-types/count/all

Get /logging/event-types/count/all

Description

Returns the count of all Event Type records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event-

types/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1589

Fortinet Inc.
Get /logging/event-types/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"eventTag": "string",
"elementType": "string",
"alarmTag": "string",
"version": 0,
"systemOnly": true,
"ncm": true,
"groupID": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T22:29:34.028Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1590

Fortinet Inc.
Get /logging/event-types/count/{id}

Get /logging/event-types/count/{id}

Description

Returns the Event Type record that matches the supplied DBID.

Request Parameter

Id, the Event Type record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event-

types/count/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1591

Fortinet Inc.
Get /logging/event-types/count/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"eventTag": "string",
"elementType": "string",
"alarmTag": "string",
"version": 0,
"systemOnly": true,
"ncm": true,
"groupID": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-05T22:29:34.028Z",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"modifyAuditSummary": "string",
"addAuditSummary": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1592

Fortinet Inc.
Get /logging/event-types/thresholds

Get /logging/event-types/thresholds

Description

Returns the thresholds for several system events, such as CPU usage, before they are triggered.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/logging/event-

types/thresholds

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1593

Fortinet Inc.
Get /logging/event-types/thresholds

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"masterProcessThreadCountWarning": "string",
"nessusProcessMemoryFreeCritical": "string",
"nessusProcessThreadCountCritical": "string",
"nessusProcessThreadCountWarning": "string",
"masterProcessMemoryFreeWarning": "string",
"masterProcessMemoryFreeCritical": "string",
"nessusProcessMemoryFreeWarning": "string",
"masterProcessThreadCountCritical": "string",
"concurrentLicenseLimitWarning": "string",
"concurrentLicenseLimitCritical": "string",
"diskFreeWarning": "string",
"diskFreeCritical": "string",
"memoryFreeWarning": "string",
"memoryFreeCritical": "string",
"networkTopologySizeWarning": "string",
"networkTopologySizeCritical": "string"
}
}

FortiNAC F 7.4.0 REST API 1594

Fortinet Inc.
Post /logging/event-types/group

Post /logging/event-types/group

Description

Sets the targeted group for one or more event types.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array<Integar>

groupID Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event-

types/group

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body groupID:xxxx

id: xxxxx

FortiNAC F 7.4.0 REST API 1595

Fortinet Inc.
Post /logging/event-types/group

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1596

Fortinet Inc.
Post /logging/event-types/logging-strategy

Post /logging/event-types/logging-strategy

Description

Sets the logging strategy for one or more event types

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array<Integar>

logLevel Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event-

types/logging-strategy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body logLevel:"xxxx"

id: xx

FortiNAC F 7.4.0 REST API 1597

Fortinet Inc.
Post /logging/event-types/logging-strategy

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1598

Fortinet Inc.
Post /logging/event-types/thresholds

Post /logging/event-types/thresholds

Description

Sets the thresholds for generating system events.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/logging/event-

types/thresholds

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"masterProcessThreadCountWarning": "string",
"nessusProcessMemoryFreeCritical": "string",
"nessusProcessThreadCountCritical": "string",
"nessusProcessThreadCountWarning": "string",
"masterProcessMemoryFreeWarning": "string",
"masterProcessMemoryFreeCritical": "string",
"nessusProcessMemoryFreeWarning": "string",
"masterProcessThreadCountCritical": "string",
"concurrentLicenseLimitWarning": "string",
"concurrentLicenseLimitCritical": "string",
"diskFreeWarning": "string",
"diskFreeCritical": "string",
"memoryFreeWarning": "string",
"memoryFreeCritical": "string",
"networkTopologySizeWarning": "string",

FortiNAC F 7.4.0 REST API 1599

Fortinet Inc.
Post /logging/event-types/thresholds

"networkTopologySizeCritical": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1600

Fortinet Inc.
Group

Group

FortiNAC F 7.4.0 REST API 1601

Fortinet Inc.
Delete /system/group/{id}

Delete /system/group/{id}

Description

Deletes the group record supplied, if it is not currently in use.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1602

Fortinet Inc.
Delete /system/group/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1603

Fortinet Inc.
Get /system/group

Get /system/group

Description

Returns all group records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1604

Fortinet Inc.
Get /system/group

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-19T21:24:18.934Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-
19T21:24:18.934Z",
"nameLabel": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1605

Fortinet Inc.
Get /system/group/count

Get /system/group/count

Description

Returns a count of group records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1606

Fortinet Inc.
Get /system/group/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-19T21:24:18.934Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-
19T21:24:18.934Z",
"nameLabel": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1607

Fortinet Inc.
Get /system/group/count/all

Get /system/group/count/all

Description

Returns the count of all group records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1608

Fortinet Inc.
Get /system/group/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-19T21:24:18.934Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-
19T21:24:18.934Z",
"nameLabel": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1609

Fortinet Inc.
Get /system/group/{id}

Get /system/group/{id}

Description

Returns the group record with the supplied DBID.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1610

Fortinet Inc.
Get /system/group/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-19T21:39:30.413Z",
"lastModifiedBy": "string",
"lastModifiedDate": 0,
"nameLabel": "string",
"members": [
{
"id": 0,
"name": "string",
"img": "string"
}
],
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-19T21:39:30.413Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string"
}
}

FortiNAC F 7.4.0 REST API 1611

Fortinet Inc.
Get /system/group/{id}/descendants

Get /system/group/{id}/descendants

Description

Returns all groups that are descendants of the supplied group. If includeParentGroup is true, the list of groups will also
include the supplied group.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

includeParent Yes Boolean

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1/descendants

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1612

Fortinet Inc.
Get /system/group/{id}/descendants

Sample Response

{
"status": "string",
"errorMessage": "string",
"groupList": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-20T18:27:41.346Z",
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-
20T18:27:41.346Z",
"nameLabel": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1613

Fortinet Inc.
Get /system/group/{id}/member-ids

Get /system/group/{id}/member-ids

Description

Returns the member IDs of all descendant members.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1/member-ids

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1614

Fortinet Inc.
Get /system/group/{id}/member-ids

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1615

Fortinet Inc.
Get /system/group/{id}/members

Get /system/group/{id}/members

Description

Returns all descendant members and subgroups for this group.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

getImages Yes Boolean

getSubGroups Yes Boolean

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1/members

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 1616

Fortinet Inc.
Get /system/group/{id}/members

Content-Type: application/json

Request Body getImages: False

getSubGroups: True

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"subgroups": [
"string"
],
"members": [
{
"id": 0,
"name": "string",
"img": "string"
}
],
"name": "string",
"imgHash": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}

FortiNAC F 7.4.0 REST API 1617

Fortinet Inc.
Get /system/group/{id}/usage

Get /system/group/{id}/usage

Description

Returns a list of group records that reference this record.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/group/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1618

Fortinet Inc.
Get /system/group/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1619

Fortinet Inc.
Post /system/group/add-members

Post /system/group/add-members

Description

Adds members to a group or groups of a certain type and also adds groups to a group of a certain type..

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

elemID Yes Array

groupID Yes Array

type Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/add-members

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body elemID: xx

groupID: xx
type: xxx

FortiNAC F 7.4.0 REST API 1620

Fortinet Inc.
Post /system/group/add-members

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1621

Fortinet Inc.
Post /system/group/add-to-parents

Post /system/group/add-to-parents

Description

Sets the parent groups to the supplied group of same type. If replace is true it also removes from any groups that this
supplied group currently belongs to and by default replace is true.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

parentID Yes Array

groupID Yes Integer

replace Yes Boolean

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/add-to-

parents

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body parentID: xxx

FortiNAC F 7.4.0 REST API 1622

Fortinet Inc.
Post /system/group/add-to-parents

groupID: xxxx
replace: True

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1623

Fortinet Inc.
Post /system/group/aging

Post /system/group/aging

Description

Sets the aging time for records in the group or groups.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

daysValid Yes Integer

daysInactive Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/aging

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: xx

daysValid: xx
daysInactive: xx

FortiNAC F 7.4.0 REST API 1624

Fortinet Inc.
Post /system/group/aging

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1625

Fortinet Inc.
Post /system/group/copy

Post /system/group/copy

Description

Creates a copy of the given group with the specified name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes String

name Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/copy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

name: "xxxxx"

FortiNAC F 7.4.0 REST API 1626

Fortinet Inc.
Post /system/group/copy

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": []
}

FortiNAC F 7.4.0 REST API 1627

Fortinet Inc.
Post /system/group/delete

Post /system/group/delete

Description

Deletes the group record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 1628

Fortinet Inc.
Post /system/group/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1629

Fortinet Inc.
Post /system/group/{groupID}/manages

Post /system/group/{groupID}/manages

Description

Sets the User, Host, and Port groups that may be managed by members of this group.

Request Parameter

groupID - the group ID of the User, Host, or Port group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/xxxxx/manages

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: xxxx

FortiNAC F 7.4.0 REST API 1630

Fortinet Inc.
Post /system/group/{groupID}/manages

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1631

Fortinet Inc.
Post /system/group/{groupType}

Post /system/group/{groupType}

Description

Adds a new user group to the database.

Request Parameter

groupType - the new user group type.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/xxxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,
"daysValid": 0,

FortiNAC F 7.4.0 REST API 1632

Fortinet Inc.
Post /system/group/{groupType}

"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-19T22:24:31.234Z",
"nameLabel": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1633

Fortinet Inc.
Post /system/group/{groupType}/{id}

Post /system/group/{groupType}/{id}

Description

Updates an existing user group in the database.

Request Parameter

groupType - the new user group type.

id - the user group DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/xxxxx/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"dbid": 0,
"elementClass": 0,
"name": "string",
"userGroup": true,
"description": "string",
"accessPolicy": 0,

FortiNAC F 7.4.0 REST API 1634

Fortinet Inc.
Post /system/group/{groupType}/{id}

"daysValid": 0,
"daysInactive": 0,
"guid": 0,
"globalModifiedDate": "2024-03-19T22:24:31.234Z",
"nameLabel": "string"
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1635

Fortinet Inc.
Post /system/group/{id}/delete

Post /system/group/{id}/delete

Description

Deletes the group record supplied, if they are not currently in use.

Request Parameter

Id, the group record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1636

Fortinet Inc.
Post /system/group/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1637

Fortinet Inc.
Post /system/group/membership

Post /system/group/membership

Description

Sets the Group Membership for the supplied groups for the supplied member.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

elemID Yes Array

groupID Yes Array

type Yes String

serverIP Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/membership

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body elemID: xx

FortiNAC F 7.4.0 REST API 1638

Fortinet Inc.
Post /system/group/membership

groupID: xx
type: xxx
serverIP:xxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1639

Fortinet Inc.
Post /system/group/remove-from-parent

Post /system/group/remove-from-parent

Description

Removes one or more groups from the supplied parent group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

parentID Yes Integer

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/remove-from-

parent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body parentID: xxx

id: xx

FortiNAC F 7.4.0 REST API 1640

Fortinet Inc.
Post /system/group/remove-from-parent

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1641

Fortinet Inc.
Post /system/group/remove-members

Post /system/group/remove-members

Description

Removes a set of member IDs from a set of group IDs, if the member exists within the group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

elemID Yes Array

groupID Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/group/remove-

members

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body elemID: xx

groupID: xx

FortiNAC F 7.4.0 REST API 1642

Fortinet Inc.
Post /system/group/remove-members

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1643

Fortinet Inc.
GuestTemplate

GuestTemplate

FortiNAC F 7.4.0 REST API 1644

Fortinet Inc.
Delete /user/guest-template/{id}

Delete /user/guest-template/{id}

Description

Deletes the guest template record supplied, if it is not currently in use.

Request Parameter

Id, the guest template record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/guest-template/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1645

Fortinet Inc.
Delete /user/guest-template/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1646

Fortinet Inc.
Get /user/guest-template

Get /user/guest-template

Description

Returns all guest template records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-template

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1647

Fortinet Inc.
Get /user/guest-template

Sample Response

FortiNAC F 7.4.0 REST API 1648

Fortinet Inc.
Get /user/guest-template

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",
"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",
"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:01:25.282Z",
"guid": 0,
"globalModifiedDate": "2024-04-
09T17:01:25.282Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}
],
"filtered": 0,
FortiNAC F 7.4.0 REST
"total": 0 API 1649
Fortinet
} Inc.
Get /user/guest-template

FortiNAC F 7.4.0 REST API 1650

Fortinet Inc.
Get /user/guest-template/count

Get /user/guest-template/count

Description

Returns a count of guest template records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-template/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1651

Fortinet Inc.
Get /user/guest-template/count

Sample Response

FortiNAC F 7.4.0 REST API 1652

Fortinet Inc.
Get /user/guest-template/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",
"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",
"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:01:25.282Z",
"guid": 0,
"globalModifiedDate": "2024-04-
09T17:01:25.282Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}
],
"filtered": 0,
FortiNAC F 7.4.0 REST
"total": 0 API 1653
Fortinet
} Inc.
Get /user/guest-template/count

FortiNAC F 7.4.0 REST API 1654

Fortinet Inc.
Get /user/guest-template/count/all

Get /user/guest-template/count/all

Description

Returns the count of all guest template records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-

template/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1655

Fortinet Inc.
Get /user/guest-template/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1656

Fortinet Inc.
Get /user/guest-template/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",
"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",
"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:01:25.282Z",
"guid": 0,
"globalModifiedDate": "2024-04-
09T17:01:25.282Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}
],
"filtered": 0,
FortiNAC F 7.4.0 REST
"total": 0 API 1657
Fortinet
} Inc.
Get /user/guest-template/count/all

FortiNAC F 7.4.0 REST API 1658

Fortinet Inc.
Get /user/guest-template/{id}

Get /user/guest-template/{id}

Description

Returns the guest template record with the supplied DBID.

Request Parameter

Id, the guest template record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-template/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1659

Fortinet Inc.
Get /user/guest-template/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1660

Fortinet Inc.
Get /user/guest-template/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",
"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",
"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:01:25.282Z",
"guid": 0,
"globalModifiedDate": "2024-04-
09T17:01:25.282Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}
],
"filtered": 0,
FortiNAC F 7.4.0 REST
"total": 0 API 1661
Fortinet
} Inc.
Get /user/guest-template/{id}

FortiNAC F 7.4.0 REST API 1662

Fortinet Inc.
Get /user/guest-template/{id}/usage

Get /user/guest-template/{id}/usage

Description

Returns a list of guest template records that reference this record.

Request Parameter

Id, the guest template record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-

template/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1663

Fortinet Inc.
Get /user/guest-template/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1664

Fortinet Inc.
Get /user/guest-template/resolve-ip

Get /user/guest-template/resolve-ip

Description

Resolves an IP address from a supplied URL or hostname.

Request Body Parameters

Name Required Type

url Yes String

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-

template/resolve-ip

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body url: xxxxxxxxxxx

FortiNAC F 7.4.0 REST API 1665

Fortinet Inc.
Get /user/guest-template/resolve-ip

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1666

Fortinet Inc.
Post /user/guest-template

Post /user/guest-template

Description

Adds a new guest template record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest-template

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",
"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",

FortiNAC F 7.4.0 REST API 1667

Fortinet Inc.
Post /user/guest-template

"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:54:38.815Z",
"guid": 0,
"globalModifiedDate": "2024-04-09T17:54:38.815Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}

FortiNAC F 7.4.0 REST API 1668

Fortinet Inc.
Post /user/guest-template

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1669

Fortinet Inc.
Post /user/guest-template/delete

Post /user/guest-template/delete

Description

Deletes the guest template record or records supplied, if they are none are currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest-

template/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

FortiNAC F 7.4.0 REST API 1670

Fortinet Inc.
Post /user/guest-template/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1671

Fortinet Inc.
Post /user/guest-template/{id}

Post /user/guest-template/{id}

Description

Updates an existing guest template record in the database.

Request Parameter

Id, the guest template record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest-template/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 2,
"name": "string",
"visitorType": 0,
"canSendEmail": true,
"canSendSMS": true,
"role": "string",
"policy": "string",

FortiNAC F 7.4.0 REST API 1672

Fortinet Inc.
Post /user/guest-template/{id}

"userNameFormat": 0,
"passwordLength": 0,
"reauthenticationPeriod": 0,
"aupURL": "string",
"aupIP": "string",
"successURL": "string",
"successIP": "string",
"passwordExclusions": "string",
"dataFields": "string",
"state": "string",
"version": 0,
"authType": 0,
"authServer": 0,
"regType": 0,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"validTime": true,
"alwaysOn": true,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0
},
"terminateAtEndOfDay": true,
"printedNote": "string",
"maxConferenceAttendees": 0,
"accountDuration": 0,
"accountDurationFromLogin": true,
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-04-09T17:54:38.815Z",
"guid": 0,
"globalModifiedDate": "2024-04-09T17:54:38.815Z",
"sendPasswordSeparately": true,
"authTypeName": "string",
"loginAvail": "string",
"loginAvailJSON": "string",
"visitorTypeName": "string"
}

FortiNAC F 7.4.0 REST API 1673

Fortinet Inc.
Post /user/guest-template/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1674

Fortinet Inc.
Post /user/guest-template/{id}/delete

Post /user/guest-template/{id}/delete

Description

Deletes the guest template record supplied, if it is not currently in use.

Request Parameter

Id, the guest template record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest-

template/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1675

Fortinet Inc.
Post /user/guest-template/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1676

Fortinet Inc.
High Availability

High Availability

FortiNAC F 7.4.0 REST API 1677

Fortinet Inc.
Get /system/high-availability

Get /system/high-availability

Description

Returns the currently configured high availability settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/high-availability

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1678

Fortinet Inc.
Get /system/high-availability

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"product": "string",
"ncm": {
"vip": "string",
"vipMask": "string",
"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"nas": {
"vip": "string",
"vipMask": "string",
"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"ncs": {
"vip": "string",
"vipMask": "string",
"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"isNCM": true,
"isNAS": true,
"isNCS": true
}
}

FortiNAC F 7.4.0 REST API 1679

Fortinet Inc.
Get /system/high-availability/password/{pwkey}

Get /system/high-availability/password/{pwkey}

Description

Returns the currently configured high availability password.

Request Parameter

pwkey, the high availability password key.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/high-

availability/password/xxxxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1680

Fortinet Inc.
Get /system/high-availability/password/{pwkey}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 1681

Fortinet Inc.
Post /system/high-availability

Post /system/high-availability

Description

Sets the high availability settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/high-availability

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"product": "string",
"ncm": {
"vip": "string",
"vipMask": "string",
"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"nas": {
"vip": "string",
"vipMask": "string",

FortiNAC F 7.4.0 REST API 1682

Fortinet Inc.
Post /system/high-availability

"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"ncs": {
"vip": "string",
"vipMask": "string",
"vname": "string",
"primaryGatewayIP": "string",
"secondaryGatewayIP": "string",
"cmPrimaryIP": "string",
"cmSecondaryIP": "string",
"cmSecondaryName": "string",
"cmPrimaryPass": "string",
"cmSecondaryPass": "string"
},
"isNCM": true,
"isNAS": true,
"isNCS": true
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1683

Fortinet Inc.
Host Record

Host Record

FortiNAC F 7.4.0 REST API 1684

Fortinet Inc.
Get /host

Get /host

Description

Returns all Host Records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1685

Fortinet Inc.
Get /host

Sample Response

FortiNAC F 7.4.0 REST API 1686

Fortinet Inc.
Get /host

"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 1904,
"state": 0,
"notes": null,
"version": 1.6,
"creationTime": "2024-02-15T23:03:19.954+0000",
"validForTime": "2024-03-16T23:03:19.954+0000",
"lastSuccessfulPoll": 0,
"applications": null,
"hostName": "DESKTOP-J7CBSQ0",
"owner": null,
"policy": null,
"hardwareType": null,
"status": 0,
"patchManagementVendor": null,
"patchManagementID": null,
"attributes": [],
"adapters": [
"00:50:56:B5:24:EA"
],
"role": null,
"type": 9,
"directoryPolicyValue": null,
"agentVersion": null,
"agentID": null,
"agentSN": null,
"agentTag": null,
"agentPlatform": null,
"iconType": "windows",
"reValidation": false,
"criticality": null,
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": null,
"reValidationAction": {
"disable": false,
"version": 1.0
},
"domainId": -1,
"loggedOnUserId": null,
"policyHints": null,
"managedByMDM": false,
"mdmCompromised": false,
"mdmCompliance": false,
"mdmDataProtection": false,
"mdmPasscodePresent": false,
"connected": false,
"ip": null,
"auditObjectName": "DESKTOP-J7CBSQ0",
"auditObjectType": {
"auditTableName": "HOSTRECORDAudit",
"mysqlTableName": "HOSTRECORD",
"idnameQuery": "select id,hostName from HOSTRECORD
},
"addAuditSummary": "",
"expired": false,
FortiNAC F 7.4.0 REST API
"scanOnConnect": false,
1687
Fortinet Inc. "vpnclient": false,
"operatingSystem": "Windows 10",
"agentPlatformEnum": null,
Get /host

FortiNAC F 7.4.0 REST API 1688

Fortinet Inc.
Get /host/{id}/health-history

Get /host/{id}/health-history

Description

Returns the health history of the Host Record with the supplied DBID.

Request Parameter

Id, Host Record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/1/health-history

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1689

Fortinet Inc.
Get /host/{id}/health-history

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"result": "string",
"date": 0,
"profile": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1690

Fortinet Inc.
Get /host/multifilter

Get /host/multifilter

Description

Returns all Host Records, with User and Adapter information, which match the supplied multifilter string.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

pods Optional Array<String>

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/multifilter

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 1691

Fortinet Inc.
Get /host/multifilter

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1692

Fortinet Inc.
Get /host/multifilter

Sample Response

FortiNAC F 7.4.0 REST API 1693

Fortinet Inc.
Get /host/multifilter

{
"status": "string",
"errorMessage": "string",
"total": 0,
"filtered": 0,
"results": [
{
"serverIP": "string",
"serverName": "string",
"serverPort": "string",
"host_status": 0,
"host_id": 0,
"host_creationTime": 0,
"host_validTime": 0,
"host_offlineAgeTime": 0,
"host_validForTimeOffline": 0,
"host_lastSuccessful": 0,
"host_containerID": 0,
"host_containerName": "string",
"host_role": "string",
"host_directoryPolicyValue": "string",
"host_pcSerialNumber": "string",
"host_hardwareType": "string",
"host_notes": "string",
"host_operatingSystem": "string",
"host_applications": "string",
"host_type": "string",
"host_owner": "string",
"host_loggedOnUserId": "string",
"host_hasPersistentAgent": true,
"host_communicatingPersistentAgent": true,
"host_isMessageReceiver": true,
"host_agentVersion": "string",
"host_agentPlatform": "string",
"host_agentTag": "string",
"host_agentID": "string",
"host_deviceType": "string",
"host_isMdmCompliance": true,
"host_isMdmCompromised": true,
"host_isMdmDataProtection": true,
"host_isMdmPasscodePresent": true,
"host_isManagedByMDM": true,
"host_vulnerabilityScanStatus": 0,
"host_vulnerabilityScanDate": 0,
"host_openPorts": "string",
"host_criticality": "string",
"host_lastModifiedBy": "string",
"host_lastModifiedDate": "2024-03-
01T00:13:52.922Z",
"host_hostName": "string",
"host_img": "string",
"user_isDeleteHostsUponExpiration": true,
"user_status": 0,
"user_id": 0,
"user_firstName": "string",
"user_lastName": "string",
"user_userID": "string",
"user_position": "string",
"user_notes": "string",
"user_email": "string",
FortiNAC F 7.4.0 REST API
"user_address": "string", 1694
Fortinet Inc. "user_city": "string",
"user_zipCode": "string",
"user_type": "string",
Get /host/multifilter

FortiNAC F 7.4.0 REST API 1695

Fortinet Inc.
Get /host/multifilter/users

Get /host/multifilter/users

Description

Returns all Host Records, with User and Adapter information, which match the supplied multifilter string.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

pods Optional Array<String>

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/multifilter/users

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 1696

Fortinet Inc.
Get /host/multifilter/users

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1697

Fortinet Inc.
Get /host/multifilter/users

Sample Response

FortiNAC F 7.4.0 REST API 1698

Fortinet Inc.
Get /host/multifilter/users

{
"status": "string",
"errorMessage": "string",
"total": 0,
"filtered": 0,
"results": [
{
"serverIP": "string",
"serverName": "string",
"serverPort": "string",
"host_status": 0,
"host_id": 0,
"host_creationTime": 0,
"host_validTime": 0,
"host_offlineAgeTime": 0,
"host_validForTimeOffline": 0,
"host_lastSuccessful": 0,
"host_containerID": 0,
"host_containerName": "string",
"host_role": "string",
"host_directoryPolicyValue": "string",
"host_pcSerialNumber": "string",
"host_hardwareType": "string",
"host_notes": "string",
"host_operatingSystem": "string",
"host_applications": "string",
"host_type": "string",
"host_owner": "string",
"host_loggedOnUserId": "string",
"host_hasPersistentAgent": true,
"host_communicatingPersistentAgent": true,
"host_isMessageReceiver": true,
"host_agentVersion": "string",
"host_agentPlatform": "string",
"host_agentTag": "string",
"host_agentID": "string",
"host_deviceType": "string",
"host_isMdmCompliance": true,
"host_isMdmCompromised": true,
"host_isMdmDataProtection": true,
"host_isMdmPasscodePresent": true,
"host_isManagedByMDM": true,
"host_vulnerabilityScanStatus": 0,
"host_vulnerabilityScanDate": 0,
"host_openPorts": "string",
"host_criticality": "string",
"host_lastModifiedBy": "string",
"host_lastModifiedDate": "2024-03-
01T00:13:52.922Z",
"host_hostName": "string",
"host_img": "string",
"user_isDeleteHostsUponExpiration": true,
"user_status": 0,
"user_id": 0,
"user_firstName": "string",
"user_lastName": "string",
"user_userID": "string",
"user_position": "string",
"user_notes": "string",
"user_email": "string",
FortiNAC F 7.4.0 REST API
"user_address": "string", 1699
Fortinet Inc. "user_city": "string",
"user_zipCode": "string",
"user_type": "string",
Get /host/multifilter/users

FortiNAC F 7.4.0 REST API 1700

Fortinet Inc.
Get /host/ncm-pods

Get /host/ncm-pods

Description

Return all Host Records, with User and Adapter information, which match the supplied multifilter string.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/ncm-pods

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1701

Fortinet Inc.
Get /host/ncm-pods

Sample Response

FortiNAC F 7.4.0 REST API 1702

Fortinet Inc.
Get /host/ncm-pods

{
"status": "string",
"errorMessage": "string",
"results": [
{
"element": {
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2024-03-01T00:09:39.054Z",
"lastSuccessfulPoll": "2024-03-
01T00:09:39.054Z",
"mibs": [
"string"
],
"requestString": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"physicalAddress": "string",
"domainName": "string",
"identification": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-01T00:09:39.054Z",
"version": 0,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
FortiNAC F 7.4.0 "elementID":
REST API 0, 1703
Fortinet Inc. "elementName": "string",
"message": "string",
"timeOfEvent": "2024-03-01T00:09:39.054Z",
Get /host/ncm-pods

FortiNAC F 7.4.0 REST API 1704

Fortinet Inc.
Get /host/search

Get /host/search

Description

Returns all Host Records which match the supplied filter, searching Hosts, Users, and Adapters

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/search

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1705

Fortinet Inc.
Get /host/search

Sample Response

FortiNAC F 7.4.0 REST API 1706

Fortinet Inc.
Get /host/search

"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 1904,
"state": 0,
"notes": null,
"version": 1.6,
"creationTime": "2024-02-15T23:03:19.954+0000",
"validForTime": "2024-03-16T23:03:19.954+0000",
"lastSuccessfulPoll": 0,
"applications": null,
"hostName": "DESKTOP-J7CBSQ0",
"owner": null,
"policy": null,
"hardwareType": null,
"status": 0,
"patchManagementVendor": null,
"patchManagementID": null,
"attributes": [],
"adapters": [
"00:50:56:B5:24:EA"
],
"role": null,
"type": 9,
"directoryPolicyValue": null,
"agentVersion": null,
"agentID": null,
"agentSN": null,
"agentTag": null,
"agentPlatform": null,
"iconType": "windows",
"reValidation": false,
"criticality": null,
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": null,
"reValidationAction": {
"disable": false,
"version": 1.0
},
"domainId": -1,
"loggedOnUserId": null,
"policyHints": null,
"managedByMDM": false,
"mdmCompromised": false,
"mdmCompliance": false,
"mdmDataProtection": false,
"mdmPasscodePresent": false,
"connected": false,
"ip": null,
"auditObjectName": "DESKTOP-J7CBSQ0",
"auditObjectType": {
"auditTableName": "HOSTRECORDAudit",
"mysqlTableName": "HOSTRECORD",
"idnameQuery": "select id,hostName from HOSTRECORD
},
"addAuditSummary": "",
"expired": false,
FortiNAC F 7.4.0 REST API
"scanOnConnect": false,
1707
Fortinet Inc. "vpnclient": false,
"operatingSystem": "Windows 10",
"agentPlatformEnum": null,
Get /host/search

FortiNAC F 7.4.0 REST API 1708

Fortinet Inc.
Post /host

Post /host

Description

Adds a new Host Record to the database

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",

FortiNAC F 7.4.0 REST API 1709

Fortinet Inc.
Post /host

"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,

FortiNAC F 7.4.0 REST API 1710

Fortinet Inc.
Post /host

"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {

FortiNAC F 7.4.0 REST API 1711

Fortinet Inc.
Post /host

"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,

FortiNAC F 7.4.0 REST API 1712

Fortinet Inc.
Post /host

"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"dummyClient": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.962Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",

FortiNAC F 7.4.0 REST API 1713

Fortinet Inc.
Post /host

"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",

FortiNAC F 7.4.0 REST API 1714

Fortinet Inc.
Post /host

"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,

FortiNAC F 7.4.0 REST API 1715

Fortinet Inc.
Post /host

"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.962Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",

FortiNAC F 7.4.0 REST API 1716

Fortinet Inc.
Post /host

"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,

FortiNAC F 7.4.0 REST API 1717

Fortinet Inc.
Post /host

"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,
"name": "string",
"hostName": "string"
},
"dummyDate": "2024-02-29T22:55:32.962Z",
"dummyApplications": [
{
"dbid": 0,

FortiNAC F 7.4.0 REST API 1718

Fortinet Inc.
Post /host

"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-02-29T22:55:32.962Z",
"source": "string",
"verificationEngine": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-29T22:55:32.962Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"osversion": "string",
"checksum": "string",
"checksumMethod": "string"
}
],
"useKnownAdapters": true,
"groupIds": [
0
],
"ssidid": 0,
"radiusfingerprint": {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-02-29T22:55:32.962Z",
"lastHeardTime": "2024-02-29T22:55:32.962Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",

FortiNAC F 7.4.0 REST API 1719

Fortinet Inc.
Post /host

"imageFile": "string",
"id": 0
}
},
"groupId": 0
},
"managedByMDM": true,
"mdmCompromised": true,
"mdmCompliance": true,
"mdmDataProtection": true,
"mdmPasscodePresent": true,
"vulnerabilityScanStatus": 0,
"messageReceiver": true,
"adapterObjects": [
{
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.962Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",

FortiNAC F 7.4.0 REST API 1720

Fortinet Inc.
Post /host

"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 1721

Fortinet Inc.
Post /host

"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",

FortiNAC F 7.4.0 REST API 1722

Fortinet Inc.
Post /host

"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.963Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},

FortiNAC F 7.4.0 REST API 1723

Fortinet Inc.
Post /host

"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,

FortiNAC F 7.4.0 REST API 1724

Fortinet Inc.
Post /host

"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,
"name": "string",
"hostName": "string"
}
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"connectedAdapter": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.963Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",

FortiNAC F 7.4.0 REST API 1725

Fortinet Inc.
Post /host

"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.963Z",
"validForTime": "2024-02-29T22:55:32.963Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.963Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,

FortiNAC F 7.4.0 REST API 1726

Fortinet Inc.
Post /host

"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",

FortiNAC F 7.4.0 REST API 1727

Fortinet Inc.
Post /host

"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.963Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",

FortiNAC F 7.4.0 REST API 1728

Fortinet Inc.
Post /host

"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 1729

Fortinet Inc.
Post /host

"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,

FortiNAC F 7.4.0 REST API 1730

Fortinet Inc.
Post /host

"name": "string",
"hostName": "string"
},
"vpnclient": true,
"primaryMac": "string",
"atRisk": true,
"adaptersAsString": "string",
"operatingSystem": "string",
"pcserialNumber": "string",
"inTopology": true,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 1731

Fortinet Inc.
Post /host

"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"disabled": true,
"directoryDisabled": true,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"expired": true,
"validForTimeOffline": 0,
"adapterIpAsString": "string",
"adapterLocation": "string",
"adapterContainerAsString": "string",
"agentPlatformEnum": "Windows",
"validTime": 0,
"validForTimeInLong": 0,
"offlineAgeTime": 0,
"vulnerabilityScanDate": 0,
"scanOnConnect": true,
"notAuthenticated": true,
"typeLabel": "string",
"userLoggedOn": true,
"scanned": true,
"persistentAgent": true,
"notCommunicatingPersistentAgent": true,
"dialUpClient": true,
"pendingAtRisk": true,
"ip": "string",
"connected": true,
"name": "string"
}

FortiNAC F 7.4.0 REST API 1732

Fortinet Inc.
Post /host

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1733

Fortinet Inc.
Post /host/disable-by-ip

Post /host/disable-by-ip

Description

Disables the Host Record that matches the supplied ip address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ip Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/disable-by-ip

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip: xxxxxxxxx

FortiNAC F 7.4.0 REST API 1734

Fortinet Inc.
Post /host/disable-by-ip

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1735

Fortinet Inc.
Post /host/disable-by-mac

Post /host/disable-by-mac

Description

Disables the Host Record that matches the supplied mac address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

mac Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/disable-by-mac

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body mac: xxxxxxxxx

FortiNAC F 7.4.0 REST API 1736

Fortinet Inc.
Post /host/disable-by-mac

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1737

Fortinet Inc.
Post /host/enable-by-ip

Post /host/enable-by-ip

Description

Enables the Host Record that matches the supplied ip address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/enable-by-ip

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip: xxxxxxxxx

Request Body Parameters

Name Required Type

ip Yes String

FortiNAC F 7.4.0 REST API 1738

Fortinet Inc.
Post /host/enable-by-ip

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1739

Fortinet Inc.
Post /host/enable-by-mac

Post /host/enable-by-mac

Description

Enables the Host Record that matches the supplied mac address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

mac Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/enable-by-mac

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body mac: xxxxxxxxx

FortiNAC F 7.4.0 REST API 1740

Fortinet Inc.
Post /host/enable-by-mac

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1741

Fortinet Inc.
Post /host/register-as-device

Post /host/register-as-device

Description

Registers the provided Host Record as device.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

role Required String

devType Required String

domainID Required String

ip Required String

regType Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/register-as-device

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 1742

Fortinet Inc.
Post /host/register-as-device

Content-Type: application/json

Request Body id: xx

role: xxxxxx
devType: xxxxxxxx
domainID: xxxxxxxx
ip: xxxxxxxx
regType: xxxxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1743

Fortinet Inc.
Post /host/set-logged-on-user

Post /host/set-logged-on-user

Description

Sets the logged on user for the Host Record that matches the supplied mac address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

mac Yes String

userID Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/set-logged-user

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body mac: xxxxxxxxx

userID: xxxxxxx

FortiNAC F 7.4.0 REST API 1744

Fortinet Inc.
Post /host/set-logged-on-user

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1745

Fortinet Inc.
Post /host/with-adapters

Post /host/with-adapters

Description

Adds a new Host Record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/with-adapters

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"notes": "string",
"version": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"lastSuccessfulPoll": 0,
"applications": "string",
"hostName": "string",
"owner": "string",
"policy": "string",
"hardwareType": "string",
"status": 0,
"patchManagementVendor": "string",
"patchManagementID": "string",

FortiNAC F 7.4.0 REST API 1746

Fortinet Inc.
Post /host/with-adapters

"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adapters": [
"string"
],
"role": "string",
"type": "string",
"directoryPolicyValue": "string",
"agentVersion": "string",
"agentID": "string",
"agentSN": "string",
"agentTag": "string",
"agentPlatform": "string",
"iconType": "string",
"reValidation": true,
"criticality": "string",
"reValidationInterval": 0,
"lastReValidation": 0,
"openPorts": "string",
"reValidationAction": {
"disable": true,
"version": 0
},
"domainId": 0,
"loggedOnUserId": "string",
"policyHints": {
"devId": 0,
"clientId": 0,
"portId": 0,
"edgeId": 0,
"userId": 0,
"userIdent": "string",
"dummyUser": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,

FortiNAC F 7.4.0 REST API 1747

Fortinet Inc.
Post /host/with-adapters

"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {

FortiNAC F 7.4.0 REST API 1748

Fortinet Inc.
Post /host/with-adapters

"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,

FortiNAC F 7.4.0 REST API 1749

Fortinet Inc.
Post /host/with-adapters

"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"dummyClient": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.962Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",

FortiNAC F 7.4.0 REST API 1750

Fortinet Inc.
Post /host/with-adapters

"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",

FortiNAC F 7.4.0 REST API 1751

Fortinet Inc.
Post /host/with-adapters

"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,

FortiNAC F 7.4.0 REST API 1752

Fortinet Inc.
Post /host/with-adapters

"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.962Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",

FortiNAC F 7.4.0 REST API 1753

Fortinet Inc.
Post /host/with-adapters

"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,

FortiNAC F 7.4.0 REST API 1754

Fortinet Inc.
Post /host/with-adapters

"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.962Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,
"name": "string",
"hostName": "string"
},
"dummyDate": "2024-02-29T22:55:32.962Z",
"dummyApplications": [
{
"dbid": 0,

FortiNAC F 7.4.0 REST API 1755

Fortinet Inc.
Post /host/with-adapters

"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-02-29T22:55:32.962Z",
"source": "string",
"verificationEngine": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-02-29T22:55:32.962Z",
"user": "string",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"osversion": "string",
"checksum": "string",
"checksumMethod": "string"
}
],
"useKnownAdapters": true,
"groupIds": [
0
],
"ssidid": 0,
"radiusfingerprint": {
"dbid": 0,
"source": "string",
"physAddress": "string",
"ipAddress": "string",
"hostName": "string",
"entityTag": "string",
"os": "string",
"createTime": "2024-02-29T22:55:32.962Z",
"lastHeardTime": "2024-02-29T22:55:32.962Z",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"entity": {
"name": "string",
"tag": "string",

FortiNAC F 7.4.0 REST API 1756

Fortinet Inc.
Post /host/with-adapters

"imageFile": "string",
"id": 0
}
},
"groupId": 0
},
"managedByMDM": true,
"mdmCompromised": true,
"mdmCompliance": true,
"mdmDataProtection": true,
"mdmPasscodePresent": true,
"vulnerabilityScanStatus": 0,
"messageReceiver": true,
"adapterObjects": [
{
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.962Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.962Z",
"validForTime": "2024-02-29T22:55:32.962Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",

FortiNAC F 7.4.0 REST API 1757

Fortinet Inc.
Post /host/with-adapters

"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.962Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 1758

Fortinet Inc.
Post /host/with-adapters

"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",

FortiNAC F 7.4.0 REST API 1759

Fortinet Inc.
Post /host/with-adapters

"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.963Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",
"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},

FortiNAC F 7.4.0 REST API 1760

Fortinet Inc.
Post /host/with-adapters

"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,

FortiNAC F 7.4.0 REST API 1761

Fortinet Inc.
Post /host/with-adapters

"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,
"name": "string",
"hostName": "string"
}
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"connectedAdapter": {
"landscape": 0,
"id": 0,
"identification": "string",
"state": "string",
"type": "string",
"vendorName": "string",
"parent": "string",
"lastSuccessfulPoll": "2024-02-29T22:55:32.963Z",
"status": 0,
"version": 0,
"user": {
"landscape": 0,
"id": 0,
"role": "string",

FortiNAC F 7.4.0 REST API 1762

Fortinet Inc.
Post /host/with-adapters

"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-29T22:55:32.963Z",
"validForTime": "2024-02-29T22:55:32.963Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-29T22:55:32.963Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"userAdministrator": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"adminUser": true,
"iconType": "string",
"validTime": 0,
"superUser": true,
"hashedPassword": "string",
"creationEvent": {
"landscape": 0,
"id": 0,

FortiNAC F 7.4.0 REST API 1763

Fortinet Inc.
Post /host/with-adapters

"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",

FortiNAC F 7.4.0 REST API 1764

Fortinet Inc.
Post /host/with-adapters

"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"validForTimeMS": 0,
"passwordFromRaw": "string",
"disabled": true,
"directoryDisabled": true,
"deleteHostsUponExpiration": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"guestContractor": true,
"apiAdmin": true,
"maxAllowedHosts": 0,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"locale": {
"displayName": "string",
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"language": "string"
},
"name": "string",
"mphval": "string"
},
"host": "string",
"clientState": "string",
"creationTime": "2024-02-29T22:55:32.963Z",
"mediumType": "string",
"location": "string",
"container": "string",
"dpcRuleId": 0,
"dpcRuleName": "string",

FortiNAC F 7.4.0 REST API 1765

Fortinet Inc.
Post /host/with-adapters

"accessValue": "string",
"authType": 0,
"innerEapType": 0,
"outerEapType": 0,
"ips": [
{
"ip": "string",
"type": "string",
"adapterID": 0
}
],
"hostID": 0,
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"ipaddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"hardwareType": "string",
"iconType": "string",
"physicalAddress": "string",
"lastName": "string",
"userID": "string",
"operatingSystem": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 1766

Fortinet Inc.
Post /host/with-adapters

"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"allIPsString": "string",
"pctype": "string",
"authTypeStr": "string",
"innerEapTypeStr": "string",
"outerEapTypeStr": "string",
"device": true,

FortiNAC F 7.4.0 REST API 1767

Fortinet Inc.
Post /host/with-adapters

"name": "string",
"hostName": "string"
},
"vpnclient": true,
"primaryMac": "string",
"atRisk": true,
"adaptersAsString": "string",
"operatingSystem": "string",
"pcserialNumber": "string",
"inTopology": true,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 1768

Fortinet Inc.
Post /host/with-adapters

"time": 0,
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-29T22:55:32.963Z",
"version": 0,
"log": true,
"eventFormatString": "string",
"time": 0,
"empty": true
},
"disabled": true,
"directoryDisabled": true,
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"expired": true,
"validForTimeOffline": 0,
"adapterIpAsString": "string",
"adapterLocation": "string",
"adapterContainerAsString": "string",
"agentPlatformEnum": "Windows",
"validTime": 0,
"validForTimeInLong": 0,
"offlineAgeTime": 0,
"vulnerabilityScanDate": 0,
"scanOnConnect": true,
"notAuthenticated": true,
"typeLabel": "string",
"userLoggedOn": true,
"scanned": true,
"persistentAgent": true,
"notCommunicatingPersistentAgent": true,
"dialUpClient": true,
"pendingAtRisk": true,
"ip": "string",
"connected": true,
"name": "string"
}

FortiNAC F 7.4.0 REST API 1769

Fortinet Inc.
Post /host/with-adapters

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1770

Fortinet Inc.
LDAP

LDAP

FortiNAC F 7.4.0 REST API 1771

Fortinet Inc.
Delete /settings/integration/ldap/{id}

Delete /settings/integration/ldap/{id}

Description

Deletes the Container record supplied, if it is not currently in use.

Request Parameter

Id, the Container record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/ldap/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1772

Fortinet Inc.
Delete /settings/integration/ldap/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1773

Fortinet Inc.
Get /settings/integration/ldap

Get /settings/integration/ldap

Description

Returns all Container records which match the supplied filter

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/ldap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1774

Fortinet Inc.
Get /settings/integration/ldap

Sample Response

FortiNAC F 7.4.0 REST API 1775

Fortinet Inc.
Get /settings/integration/ldap

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"id": 0,
"name": "string",
"ip": "string",
"connectByName": true,
"protocol": "string",
"pollable": true,
"pollInterval": 0,
"deviceGroup": "string",
"type": "string",
"description": "string",
"state": "string",
"status": "string",
"landscape": 0,
"mac": "string",
"ldapSyncState": true,
"ldapAddDirectoryUsers": true,
"ldapDomainName": "string",
"ldapRedundantHost": "string",
"ldapLoginDN": "string",
"ldapPort": 0,
"ldapVersion": "string",
"ldapTimeLimit": "string",
"ldapRemoveClients": "string",
"ldapPassword": "string",
"ldapClientClassObject": "string",
"ldapGroupClassObject": "string",
"ldapSSLConnectionType": "string",
"ldapCharacterSet": "string",
"ldapClientSearchBranch": [
"string"
],
"ldapGroupSearchBranch": [
"string"
],
"clientName": "string",
"clientPassword": "string",
"clientFirstName": "string",
"clientLastName": "string",
"clientID": "string",
"clientAddress": "string",
"clientCity": "string",
"clientState": "string",
"clientZipCode": "string",
"clientTelephoneNumber": "string",
"clientMobileNumber": "string",
"clientMobileProvider": "string",
"clienteMail": "string",
"clientVlanId": "string",
"clientUnitName": "string",
"clientScanPolicy": "string",
"clientNumRecords": "string",
"clientDeleteTime": "string",
"clientDeleteUnits": "string",
"ldapClientDisableAttr": "string",
FortiNAC F"ldapClientDisableValue":
7.4.0 REST API "string", 1776
Fortinet Inc.
"referrals": "string",
"groupName": "string",
"groupMembers": "string",
Get /settings/integration/ldap

FortiNAC F 7.4.0 REST API 1777

Fortinet Inc.
Get /settings/integration/ldap/count

Get /settings/integration/ldap/count

Description

Returns a count of Container records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/ldap/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1778

Fortinet Inc.
Get /settings/integration/ldap/count

Sample Response

FortiNAC F 7.4.0 REST API 1779

Fortinet Inc.
Get /settings/integration/ldap/count

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"id": 0,
"name": "string",
"ip": "string",
"connectByName": true,
"protocol": "string",
"pollable": true,
"pollInterval": 0,
"deviceGroup": "string",
"type": "string",
"description": "string",
"state": "string",
"status": "string",
"landscape": 0,
"mac": "string",
"ldapSyncState": true,
"ldapAddDirectoryUsers": true,
"ldapDomainName": "string",
"ldapRedundantHost": "string",
"ldapLoginDN": "string",
"ldapPort": 0,
"ldapVersion": "string",
"ldapTimeLimit": "string",
"ldapRemoveClients": "string",
"ldapPassword": "string",
"ldapClientClassObject": "string",
"ldapGroupClassObject": "string",
"ldapSSLConnectionType": "string",
"ldapCharacterSet": "string",
"ldapClientSearchBranch": [
"string"
],
"ldapGroupSearchBranch": [
"string"
],
"clientName": "string",
"clientPassword": "string",
"clientFirstName": "string",
"clientLastName": "string",
"clientID": "string",
"clientAddress": "string",
"clientCity": "string",
"clientState": "string",
"clientZipCode": "string",
"clientTelephoneNumber": "string",
"clientMobileNumber": "string",
"clientMobileProvider": "string",
"clienteMail": "string",
"clientVlanId": "string",
"clientUnitName": "string",
"clientScanPolicy": "string",
"clientNumRecords": "string",
"clientDeleteTime": "string",
"clientDeleteUnits": "string",
"ldapClientDisableAttr": "string",
FortiNAC F"ldapClientDisableValue":
7.4.0 REST API "string", 1780
Fortinet Inc.
"referrals": "string",
"groupName": "string",
"groupMembers": "string",
Get /settings/integration/ldap/count

FortiNAC F 7.4.0 REST API 1781

Fortinet Inc.
Get /settings/integration/ldap/count/all

Get /settings/integration/ldap/count/all

Description

Returns the count of all Container records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/ldap/count/all

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1782

Fortinet Inc.
Get /settings/integration/ldap/count/all

Sample Response

FortiNAC F 7.4.0 REST API 1783

Fortinet Inc.
Get /settings/integration/ldap/count/all

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"id": 0,
"name": "string",
"ip": "string",
"connectByName": true,
"protocol": "string",
"pollable": true,
"pollInterval": 0,
"deviceGroup": "string",
"type": "string",
"description": "string",
"state": "string",
"status": "string",
"landscape": 0,
"mac": "string",
"ldapSyncState": true,
"ldapAddDirectoryUsers": true,
"ldapDomainName": "string",
"ldapRedundantHost": "string",
"ldapLoginDN": "string",
"ldapPort": 0,
"ldapVersion": "string",
"ldapTimeLimit": "string",
"ldapRemoveClients": "string",
"ldapPassword": "string",
"ldapClientClassObject": "string",
"ldapGroupClassObject": "string",
"ldapSSLConnectionType": "string",
"ldapCharacterSet": "string",
"ldapClientSearchBranch": [
"string"
],
"ldapGroupSearchBranch": [
"string"
],
"clientName": "string",
"clientPassword": "string",
"clientFirstName": "string",
"clientLastName": "string",
"clientID": "string",
"clientAddress": "string",
"clientCity": "string",
"clientState": "string",
"clientZipCode": "string",
"clientTelephoneNumber": "string",
"clientMobileNumber": "string",
"clientMobileProvider": "string",
"clienteMail": "string",
"clientVlanId": "string",
"clientUnitName": "string",
"clientScanPolicy": "string",
"clientNumRecords": "string",
"clientDeleteTime": "string",
"clientDeleteUnits": "string",
"ldapClientDisableAttr": "string",
FortiNAC F"ldapClientDisableValue":
7.4.0 REST API "string", 1784
Fortinet Inc.
"referrals": "string",
"groupName": "string",
"groupMembers": "string",
Get /settings/integration/ldap/count/all

FortiNAC F 7.4.0 REST API 1785

Fortinet Inc.
Get /settings/integration/ldap/{id}

Get /settings/integration/ldap/{id}

Description

Returns the count of all Container records in the database.

Request Parameter

Id, the Container record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/ldap/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1786

Fortinet Inc.
Get /settings/integration/ldap/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1787

Fortinet Inc.
Get /settings/integration/ldap/{id}

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"id": 0,
"name": "string",
"ip": "string",
"connectByName": true,
"protocol": "string",
"pollable": true,
"pollInterval": 0,
"deviceGroup": "string",
"type": "string",
"description": "string",
"state": "string",
"status": "string",
"landscape": 0,
"mac": "string",
"ldapSyncState": true,
"ldapAddDirectoryUsers": true,
"ldapDomainName": "string",
"ldapRedundantHost": "string",
"ldapLoginDN": "string",
"ldapPort": 0,
"ldapVersion": "string",
"ldapTimeLimit": "string",
"ldapRemoveClients": "string",
"ldapPassword": "string",
"ldapClientClassObject": "string",
"ldapGroupClassObject": "string",
"ldapSSLConnectionType": "string",
"ldapCharacterSet": "string",
"ldapClientSearchBranch": [
"string"
],
"ldapGroupSearchBranch": [
"string"
],
"clientName": "string",
"clientPassword": "string",
"clientFirstName": "string",
"clientLastName": "string",
"clientID": "string",
"clientAddress": "string",
"clientCity": "string",
"clientState": "string",
"clientZipCode": "string",
"clientTelephoneNumber": "string",
"clientMobileNumber": "string",
"clientMobileProvider": "string",
"clienteMail": "string",
"clientVlanId": "string",
"clientUnitName": "string",
"clientScanPolicy": "string",
"clientNumRecords": "string",
"clientDeleteTime": "string",
"clientDeleteUnits": "string",
"ldapClientDisableAttr": "string",
FortiNAC F"ldapClientDisableValue":
7.4.0 REST API "string", 1788
Fortinet Inc.
"referrals": "string",
"groupName": "string",
"groupMembers": "string",
Get /settings/integration/ldap/{id}

FortiNAC F 7.4.0 REST API 1789

Fortinet Inc.
Get /settings/integration/ldap/{id}/usage

Get /settings/integration/ldap/{id}/usage

Description

Returns a list of Container records that reference this record

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/ldap/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1790

Fortinet Inc.
Get /settings/integration/ldap/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string"
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1791

Fortinet Inc.
Post /settings/integration/ldap

Post /settings/integration/ldap

Description

Adds a new Container record to the database

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/ldap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"note": "string",
"defaultAPLocation": true
}

FortiNAC F 7.4.0 REST API 1792

Fortinet Inc.
Post /settings/integration/ldap

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1793

Fortinet Inc.
Post /settings/integration/ldap/delete

Post /settings/integration/ldap/delete

Description

Deletes the Container record or records supplied, if they are not currently in use

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/ldap/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1794

Fortinet Inc.
Post /settings/integration/ldap/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1795

Fortinet Inc.
Post /settings/integration/ldap/{id}

Post /settings/integration/ldap/{id}

Description

Updates an existing Container record in the database.

Request Parameter

Id, the Container record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/ldap/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"note": "string",
"defaultAPLocation": true
}

FortiNAC F 7.4.0 REST API 1796

Fortinet Inc.
Post /settings/integration/ldap/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1797

Fortinet Inc.
Post /settings/integration/ldap/{id}/delete

Post /settings/integration/ldap/{id}/delete

Description

Deletes the Container record supplied, if it is not currently in use.

Request Parameter

Id, the Container record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/ldap/6/delete

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1798

Fortinet Inc.
Post /settings/integration/ldap/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1799

Fortinet Inc.
License Management

License Management

FortiNAC F 7.4.0 REST API 1800

Fortinet Inc.
Get /system/license-management

Get /system/license-management

Description

Returns the License information.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

deviceIP Yes String

deviceProxy Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/license-management

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body deviceIP: "xxxxxxx"

deviceProxy: "xxxxxxxxxx"

FortiNAC F 7.4.0 REST API 1801

Fortinet Inc.
Get /system/license-management

Sample Response

{
"status": "string",
"errorMessage": "string",
"inUseCount": 0,
"totalCount": 0,
"availCount": 0,
"usedPercent": 0,
"rtrInUseCount": 0,
"rtrTotalCount": 0,
"rtrAvailCount": 0,
"rtrUsedPercent": 0,
"concurrentLimitWarning": "string",
"concurrentLimitCritical": "string",
"masterDBID": 0,
"contracts": [
{
"code": "string",
"description": "string",
"expration": "2024-03-20",
"supportLevel": "string",
"supportDescription": "string"
}
]

FortiNAC F 7.4.0 REST API 1802

Fortinet Inc.
Log Receiver

Log Receiver

FortiNAC F 7.4.0 REST API 1803

Fortinet Inc.
Get /settings/integration/log-receiver

Get /settings/integration/log-receiver

Description

Returns the currently configured Log Receivers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/log-

receiver

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1804

Fortinet Inc.
Get /settings/integration/log-receiver

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"logHost": {
"version": 0,
"ip": "string",
"type": "string",
"port": 0,
"facility": 0,
"severity": 0,
"status": "string",
"security": "string"
},
"dbid": 0
}
]
}

FortiNAC F 7.4.0 REST API 1805

Fortinet Inc.
Post /settings/integration/log-receiver

Post /settings/integration/log-receiver

Description

Adds or modifies a Log Receiver.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/log-

receiver

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"logHost": {
"version": 0,
"ip": "string",
"type": "string",
"port": 0,
"facility": 0,
"severity": 0,
"status": "string",
"security": "string"
},
"dbid": 0
}

FortiNAC F 7.4.0 REST API 1806

Fortinet Inc.
Post /settings/integration/log-receiver

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1807

Fortinet Inc.
Post /settings/integration/log-receiver/delete

Post /settings/integration/log-receiver/delete

Description

Delete a Log Receiver.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

dbid Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/log-

receiver

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body dbid: 4

FortiNAC F 7.4.0 REST API 1808

Fortinet Inc.
Post /settings/integration/log-receiver/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1809

Fortinet Inc.
Logical Network

Logical Network

FortiNAC F 7.4.0 REST API 1810

Fortinet Inc.
Get /policy/logical-network

Get /policy/logical-network

Description

Returns a list of records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1811

Fortinet Inc.
Get /policy/logical-network

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T18:11:19.838Z",
"id": 0,
"name": "W\\MtXt",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-
12T18:11:19.838Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T18:11:19.838Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1812

Fortinet Inc.
Get /policy/logical-network/{id}

Get /policy/logical-network/{id}

Description

Returns a list of records matching the supplied filter.

Request Parameter

Id, the logical record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-network/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1813

Fortinet Inc.
Get /policy/logical-network/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T18:34:06.055Z",
"id": 0,
"name": "P_qx(gS& )^fA+o(<rtP^4~A^;$1",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-
12T18:34:06.055Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T18:34:06.055Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1814

Fortinet Inc.
Get /policy/logical-network/{id}/usage

Get /policy/logical-network/{id}/usage

Description

Returns a list of records that reference this record.

Request Parameter

Id, the logical record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/logical-

network/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1815

Fortinet Inc.
Get /policy/logical-network/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1816

Fortinet Inc.
Post /policy/logical-network

Post /policy/logical-network

Description

Creates a new record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "Kw$e(!Y2~3D`\"D02`+Rj$.GbwSqP6iuj-eoLC3t{J73_^
(DQG);jU<4=n_k0;5DT)^Y",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-12T18:26:49.141Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",

FortiNAC F 7.4.0 REST API 1817

Fortinet Inc.
Post /policy/logical-network

"timestamp": "2024-03-12T18:26:49.141Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1818

Fortinet Inc.
Post /policy/logical-network/add-predefined-network-access

Post /policy/logical-network/add-predefined-network-
access

Description

Creates a predefined set of Logical Networks and Policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-

network/add-predefined-network-access

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1819

Fortinet Inc.
Post /policy/logical-network/add-predefined-network-access

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 1820

Fortinet Inc.
Post /policy/logical-network/delete

Post /policy/logical-network/delete

Description

Deletes a list of records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-

network/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 8

FortiNAC F 7.4.0 REST API 1821

Fortinet Inc.
Post /policy/logical-network/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1822

Fortinet Inc.
Post /policy/logical-network/{id}

Post /policy/logical-network/{id}

Description

Updates an record.

Request Parameter

Id, the logical record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-network/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "Kw$e(!Y2~3D`\"D02`+Rj$.GbwSqP6iuj-eoLC3t{J73_^
(DQG);jU<4=n_k0;5DT)^Y",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-03-12T18:26:49.141Z",
"dbid": 0,
"auditObj": {
"auditDBID": 0,

FortiNAC F 7.4.0 REST API 1823

Fortinet Inc.
Post /policy/logical-network/{id}

"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T18:26:49.141Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1824

Fortinet Inc.
Post /policy/logical-network/{id}/delete

Post /policy/logical-network/{id}/delete

Description

Deletes a single record by ID.

Request Parameter

Id, the logical record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/logical-

network/3/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1825

Fortinet Inc.
Post /policy/logical-network/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1826

Fortinet Inc.
Delete /policy/logical-network/{id}

Delete /policy/logical-network/{id}

Description

Deletes a single record by ID.

Request Parameter

Id, the logical record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/logical-

network/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1827

Fortinet Inc.
Delete /policy/logical-network/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1828

Fortinet Inc.
MDM

MDM

FortiNAC F 7.4.0 REST API 1829

Fortinet Inc.
Delete /settings/integration/mdm/{id}

Delete /settings/integration/mdm/{id}

Description

Deletes a single MDM record by ID

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/delete/6

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1830

Fortinet Inc.
Delete /settings/integration/mdm/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1831

Fortinet Inc.
Get /settings/integration/mdm

Get /settings/integration/mdm

Description

Returns a list of MDM records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/mdm

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1832

Fortinet Inc.
Get /settings/integration/mdm

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"version": "string",
"request": "string",
"identifier": "string",
"userID": "string",
"credentialText": "string",
"pluginName": "string",
"deleteOnRemove": true,
"onDemandRegistration": true,
"reValidation": true,
"updateApplications": true,
"poll": true,
"pollInterval": 0,
"lastPoll": "2024-03-13T22:22:49.643Z",
"lastSuccessfulPoll": "2024-03-
13T22:22:49.643Z",
"createDate": "2024-03-13T22:22:49.643Z",
"maaS360PlatformID": "string",
"maaS360AppID": "string",
"maaS360AppVersion": "string",
"maaS360AppAccessKey": "string",
"otOnly": true,
"approvedOnly": true,
"insecureSSL": true,
"riskLevel": "string",
"complianceRetrieval": true,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"option1": "string",
"option2": "string",
"option3": "string",
"option4": "string",
"connectTimeout": 0,
"readTimeout": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1833

Fortinet Inc.
Get /settings/integration/mdm/{id}

Get /settings/integration/mdm/{id}

Description

Returns a list of MDM records matching the supplied filter.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/mdm/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1834

Fortinet Inc.
Get /settings/integration/mdm/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"version": "string",
"request": "string",
"identifier": "string",
"userID": "string",
"credentialText": "string",
"pluginName": "string",
"deleteOnRemove": true,
"onDemandRegistration": true,
"reValidation": true,
"updateApplications": true,
"poll": true,
"pollInterval": 0,
"lastPoll": "2024-03-13T22:22:49.643Z",
"lastSuccessfulPoll": "2024-03-
13T22:22:49.643Z",
"createDate": "2024-03-13T22:22:49.643Z",
"maaS360PlatformID": "string",
"maaS360AppID": "string",
"maaS360AppVersion": "string",
"maaS360AppAccessKey": "string",
"otOnly": true,
"approvedOnly": true,
"insecureSSL": true,
"riskLevel": "string",
"complianceRetrieval": true,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"option1": "string",
"option2": "string",
"option3": "string",
"option4": "string",
"connectTimeout": 0,
"readTimeout": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1835

Fortinet Inc.
Get /settings/integration/mdm/{id}/password

Get /settings/integration/mdm/{id}/password

Description

Returns the configured password used to communicate with the MDM server.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/mdm/3/password

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1836

Fortinet Inc.
Get /settings/integration/mdm/{id}/password

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 1837

Fortinet Inc.
Get /settings/integration/mdm/{id}/usage

Get /settings/integration/mdm/{id}/usage

Description

Returns a list of records that reference this MDM record.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/mdm/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1838

Fortinet Inc.
Get /settings/integration/mdm/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1839

Fortinet Inc.
Post /settings/integration/mdm

Post /settings/integration/mdm

Description

Creates a new MDM record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"version": "string",
"request": "string",
"identifier": "string",
"userID": "string",
"password": "string",
"credentialText": "string",
"pluginName": "string",
"deleteOnRemove": true,
"onDemandRegistration": true,
"reValidation": true,
"updateApplications": true,
"poll": true,
"pollInterval": 0,
"lastPoll": "2024-03-13T22:30:50.174Z",

FortiNAC F 7.4.0 REST API 1840

Fortinet Inc.
Post /settings/integration/mdm

"lastSuccessfulPoll": "2024-03-13T22:30:50.174Z",
"createDate": "2024-03-13T22:30:50.174Z",
"maaS360PlatformID": "string",
"maaS360AppID": "string",
"maaS360AppVersion": "string",
"maaS360AppAccessKey": "string",
"otOnly": true,
"approvedOnly": true,
"insecureSSL": true,
"riskLevel": "string",
"complianceRetrieval": true,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"option1": "string",
"option2": "string",
"option3": "string",
"option4": "string",
"connectTimeout": 0,
"readTimeout": 0
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1841

Fortinet Inc.
Post /settings/integration/mdm/delete

Post /settings/integration/mdm/delete

Description

Deletes a list of MDM records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ids Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ids: 6

FortiNAC F 7.4.0 REST API 1842

Fortinet Inc.
Post /settings/integration/mdm/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1843

Fortinet Inc.
Post /settings/integration/mdm/{id}

Post /settings/integration/mdm/{id}

Description

Updates an MDM record.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"version": "string",
"request": "string",
"identifier": "string",
"userID": "string",
"password": "string",
"credentialText": "string",

FortiNAC F 7.4.0 REST API 1844

Fortinet Inc.
Post /settings/integration/mdm/{id}

"pluginName": "string",
"deleteOnRemove": true,
"onDemandRegistration": true,
"reValidation": true,
"updateApplications": true,
"poll": true,
"pollInterval": 0,
"lastPoll": "2024-03-13T22:30:50.174Z",
"lastSuccessfulPoll": "2024-03-13T22:30:50.174Z",
"createDate": "2024-03-13T22:30:50.174Z",
"maaS360PlatformID": "string",
"maaS360AppID": "string",
"maaS360AppVersion": "string",
"maaS360AppAccessKey": "string",
"otOnly": true,
"approvedOnly": true,
"insecureSSL": true,
"riskLevel": "string",
"complianceRetrieval": true,
"sslVerifyCert": true,
"sslVerifyHostname": true,
"option1": "string",
"option2": "string",
"option3": "string",
"option4": "string",
"connectTimeout": 0,
"readTimeout": 0
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1845

Fortinet Inc.
Post /settings/integration/mdm/authenticate

Post /settings/integration/mdm/authenticate

Description

Authenticates against an MDM server and returns the refresh token. This is not required for all vendors.

Request Body Parameters

Name Required Type

mdmVendor Required String

applicationID Required String

identifier Required String

appAccessKey Required String

appRequest Required String

appVersion Required String

platformID Required String

authCode Required String

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

FortiNAC F 7.4.0 REST API 1846

Fortinet Inc.
Post /settings/integration/mdm/authenticate

Sample Request

Request POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/authenticate

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request mdmVendor: "xxxxxxxx"

Body applicationID: "xxxxxxxx"
identifier: "xxxxxxxx"
appAccessKey: "xxxxxxxx"
appRequest: "xxxxxxxx"
appVersion: "xxxxxxxx"
platformID: "xxxxxxxx"
authCode: "xxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1847

Fortinet Inc.
Post /settings/integration/mdm/{id}/delete

Post /settings/integration/mdm/{id}/delete

Description

Deletes a single MDM record by ID.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/4/delete

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 1848

Fortinet Inc.
Post /settings/integration/mdm/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1849

Fortinet Inc.
Post /settings/integration/mdm/{id}/poll

Post /settings/integration/mdm/{id}/poll

Description

Polls and resynchronizes with an MDM service.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/1/poll

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1850

Fortinet Inc.
Post /settings/integration/mdm/{id}/poll

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1851

Fortinet Inc.
Post /settings/integration/mdm/{id}/test

Post /settings/integration/mdm/{id}/test

Description

Tests connection with the MDM server, but does not update or synchronize.

Request Parameter

Id, the MDM record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/mdm/3/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1852

Fortinet Inc.
Post /settings/integration/mdm/{id}/test

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1853

Fortinet Inc.
Proxy

Proxy

FortiNAC F 7.4.0 REST API 1854

Fortinet Inc.
Get /settings/integration/proxy

Get /settings/integration/proxy

Description

Returns the currently configured Proxy settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/proxy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1855

Fortinet Inc.
Get /settings/integration/proxy

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"httpProxyHost": "string",
"httpProxyPort": "string",
"httpProxyUser": "string",
"httpNonProxyHosts": "string",
"httpProxyPassword": "string",
"httpsProxyPassword": "string",
"httpsProxyHost": "string",
"httpsProxyPort": "string",
"httpsProxyUser": "string",
"ftpProxyHost": "string",
"ftpProxyPort": "string",
"ftpProxyUser": "string",
"ftpProxyPassword": "string",
"ftpNonProxyHosts": "string"
}
}

FortiNAC F 7.4.0 REST API 1856

Fortinet Inc.
Post /settings/integration/proxy

Post /settings/integration/proxy

Description

Add Proxy settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Name Required Type

httpProxyHost Yes String

httpProxyPort Yes String

httpProxyUser Yes String

httpNonProxyHosts Yes String

httpProxyPassword Yes String

httpsProxyPassword Yes String

httpsProxyHost Yes String

httpsProxyPort Yes String

httpsProxyUser Yes String

ftpProxyHost Yes String

ftpProxyPort Yes String

ftpProxyUser Yes String

ftpProxyPassword Yes String

ftpNonProxyHosts Yes String

FortiNAC F 7.4.0 REST API 1857

Fortinet Inc.
Post /settings/integration/proxy

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/proxy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body httpProxyHost: "xxxxxxxxxx"

httpProxyPort: "xxxxxxxxxx"
httpProxyUser: "xxxxxxxxxx"
httpNonProxyHosts: "xxxxxxxxxx"
httpProxyPassword: "xxxxxxxxxx"
httpsProxyPassword: "xxxxxxxxxx"
httpsProxyHost: "xxxxxxxxxx"
httpsProxyPort: "xxxxxxxxxx"
httpsProxyUser: "xxxxxxxxxx"
ftpProxyHost: "xxxxxxxxxx"
ftpProxyPort: "xxxxxxxxxx"
ftpProxyUser: "xxxxxxxxxx"
ftpProxyPassword: "xxxxxxxxxx"
ftpNonProxyHosts: "xxxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1858

Fortinet Inc.
Role

Role

FortiNAC F 7.4.0 REST API 1859

Fortinet Inc.
Delete /policy/role/{id}

Delete /policy/role/{id}

Description

Deletes a single role record by ID.

Request Parameter

Id, the role record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/role/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1860

Fortinet Inc.
Delete /policy/role/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1861

Fortinet Inc.
Get /policy/role

Get /policy/role

Description

Returns a list of role records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1862

Fortinet Inc.
Get /policy/role

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T21:07:29.016Z",
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-
12T21:07:29.016Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T21:07:29.016Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"groupIDs": [
0
],
"groupNames": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1863

Fortinet Inc.
Get /policy/role/{id}

Get /policy/role/{id}

Description

Returns a list of role records matching the supplied filter.

Request Parameter

Id, the role record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1864

Fortinet Inc.
Get /policy/role/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T21:07:29.016Z",
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-
12T21:07:29.016Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T21:07:29.016Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"groupIDs": [
0
],
"groupNames": [
"string"
],
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1865

Fortinet Inc.
Get /policy/role/{id}/usage

Get /policy/role/{id}/usage

Description

Returns a list of role records that reference this record.

Request Parameter

Id, the role record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role/3/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1866

Fortinet Inc.
Get /policy/role/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1867

Fortinet Inc.
Get /policy/role/simple

Get /policy/role/simple

Description

Returns the Name and ID of all Roles

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role/simple

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1868

Fortinet Inc.
Get /policy/role/simple

Sample Response

{
"status": "string",
"errorMessage": "string",
"groups": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1869

Fortinet Inc.
Get /policy/role/supporting-info

Get /policy/role/supporting-info

Description

Retrieves information necessary to create or modify a role, such as Host and User groups.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1870

Fortinet Inc.
Get /policy/role/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"groups": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1871

Fortinet Inc.
Post /policy/role

Post /policy/role

Description

Creates a new role record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T21:28:49.512Z",
"name": "string",
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-12T21:28:49.512Z",

FortiNAC F 7.4.0 REST API 1872

Fortinet Inc.
Post /policy/role

"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T21:28:49.512Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 0
}

FortiNAC F 7.4.0 REST API 1873

Fortinet Inc.
Post /policy/role/delete

Post /policy/role/delete

Description

Deletes a list of role records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 5

FortiNAC F 7.4.0 REST API 1874

Fortinet Inc.
Post /policy/role/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1875

Fortinet Inc.
Post /policy/role/{id}

Post /policy/role/{id}

Description

Updates an role record.

Request Parameter

Id, the role record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-03-12T21:28:49.512Z",
"name": "string",
"groups": [
{

FortiNAC F 7.4.0 REST API 1876

Fortinet Inc.
Post /policy/role/{id}

"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-03-12T21:28:49.512Z",
"auditObj": {
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"user": "string",
"action": "string",
"timestamp": "2024-03-12T21:28:49.512Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1877

Fortinet Inc.
Post /policy/role/{id}/delete

Post /policy/role/{id}/delete

Description

Deletes a single role record by ID.

Request Parameter

Id, the role record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role/4/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1878

Fortinet Inc.
Post /policy/role/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1879

Fortinet Inc.
Post /policy/role/rank/set

Post /policy/role/rank/set

Description

Sets the rank of the supplied role, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

rank Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 2

rank: 1

FortiNAC F 7.4.0 REST API 1880

Fortinet Inc.
Post /policy/role/rank/set

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1881

Fortinet Inc.
Post /policy/role/rank/swap

Post /policy/role/rank/swap

Description

Swaps the rank position of the two supplied roles.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Yes Integer

id2 Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 1

id2: 3

FortiNAC F 7.4.0 REST API 1882

Fortinet Inc.
Post /policy/role/rank/swap

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1883

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}/delete

Post /settings/integration/vendor-oui/{id}/delete

Description

Deletes the Vendor OUI record supplied, if they are not currently in use.

Request Parameter

Id, the Vendor OUI record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1884

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1885

Fortinet Inc.
Services

Services

FortiNAC F 7.4.0 REST API 1886

Fortinet Inc.
Get /system/ntp

Get /system/ntp

Description

Gets the NTP configuration to use for this appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ip Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/ntp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip: "xxxxxxxxx"

FortiNAC F 7.4.0 REST API 1887

Fortinet Inc.
Get /system/ntp

Sample Response

{
"status": "string",
"errorMessage": "string",
"ntp": "string",
"timezone": "string"
}

FortiNAC F 7.4.0 REST API 1888

Fortinet Inc.
Get /system/ntp/servers

Get /system/ntp/servers

Description

Gets the servers available for NTP configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/ntp/servers

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1889

Fortinet Inc.
Get /system/ntp/servers

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"ip": "string",
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1890

Fortinet Inc.
Post /system/ntp

Post /system/ntp

Description

Sets the NTP configuration to use for this appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

timezone Yes String

NTPAddr Yes String

IPParam Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/ntp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body timezone: "xxxxxxxxxx"

NTPAddr: "xxxxxxxxxxx"
IPParam: "xxxxxxxxxx"

FortiNAC F 7.4.0 REST API 1891

Fortinet Inc.
Post /system/ntp

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1892

Fortinet Inc.
SNMP

SNMP

FortiNAC F 7.4.0 REST API 1893

Fortinet Inc.
Get /settings/integration/SNMP

Get /settings/integration/SNMP

Description

Returns the currently configured SNMP Settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/SNMP

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1894

Fortinet Inc.
Get /settings/integration/SNMP

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"snmpProto": "string",
"authProto": "string",
"username": "string",
"security": "string",
"authPasswd": "string",
"privPasswd": "string",
"privProto": "string",
"hostsArray": [
"string"
],
"snmpProtocol": "string",
"authProtocol": "string",
"securityString": "string",
"authPassword": "string",
"privPassword": "string",
"privProtocol": "string",
"mgmtHosts": [
"string"
]
}
}

FortiNAC F 7.4.0 REST API 1895

Fortinet Inc.
Get /settings/integration/SNMP/auth-pssword

Get /settings/integration/SNMP/auth-pssword

Description

Returns the currently configured SNMP Authorization Password.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/SNMP/auth-

password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1896

Fortinet Inc.
Get /settings/integration/SNMP/auth-pssword

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1897

Fortinet Inc.
Get /settings/integration/SNMP/priv-pssword

Get /settings/integration/SNMP/priv-pssword

Description

Returns the currently configured SNMP Private Password.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/SNMP/priv-

password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1898

Fortinet Inc.
Get /settings/integration/SNMP/priv-pssword

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 1899

Fortinet Inc.
Post /settings/integration/SNMP

Post /settings/integration/SNMP

Description

Sets the snmp settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

snmpProto Yes String

authProto Yes String

username Yes String

security Yes String

authPasswd Yes String

privPasswd Yes String

privProto Yes String

hostsArray Yes Array

snmpProtocol Yes String

authProtocol Yes String

authPassword Yes String

FortiNAC F 7.4.0 REST API 1900

Fortinet Inc.
Post /settings/integration/SNMP

Name Required Type

privPassword Yes String

privProtocol Yes String

mgmtHosts Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/SNMP

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body snmpProto: "xxxxxxxxx"

authProto: "xxxxxxxxx"
username: "xxxxxxxxx"
security: "xxxxxxxxx"
authPasswd: "xxxxxxxxx"
privPasswd: "xxxxxxxxx"
privProto: "xxxxxxxxx"
hostsArray: "xxxxxxxxx"
snmpProtocol: "xxxxxxxxx"
authProtocol: "xxxxxxxxx"
authPassword: "xxxxxxxxx"
privPassword: "xxxxxxxxx"
privProtocol: "xxxxxxxxx"
mgmtHosts: "xxxxxxxxx"

FortiNAC F 7.4.0 REST API 1901

Fortinet Inc.
Post /settings/integration/SNMP

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1902

Fortinet Inc.
System

System

FortiNAC F 7.4.0 REST API 1903

Fortinet Inc.
Get /system/local-properties/cluster

Get /system/local-properties/cluster

Description

Returns all of the servers in the local cluster, composed of the Control/Application pair and any High Availability servers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

Boolean (Default:
nacServers Yes
true)

Boolean (Default:
ncmServers Yes
false)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/software-details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body nacServers: true

ncmServers: false

FortiNAC F 7.4.0 REST API 1904

Fortinet Inc.
Get /system/local-properties/cluster

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"ip": "string",
"product": "string",
"label": "string",
"type": "string",
"version": "string",
"firmware": "string",
"appliance": "string",
"primary": true,
"l3HA": true,
"slaveInControl": true,
"status": "string",
"serialNumber": "string",
"certificates": true,
"os": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1905

Fortinet Inc.
Get /system/local-properties/config-status

Get /system/local-properties/config-status

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/config-status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1906

Fortinet Inc.
Get /system/local-properties/config-status

Sample Response

{
"status": "string",
"errorMessage": "string",
"isVM": true,
"isInitialConfiguration": true,
"uuid": "string",
"mac": "string",
"licenseKey": "string",
"platformVersion": 0
}

FortiNAC F 7.4.0 REST API 1907

Fortinet Inc.
Get /system/local-properties/globaloption/{param}

Get /system/local-properties/globaloption/{param}

Description

Returns the global option value for the specified global option key.

Request Parameter

param - the global option key.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/globaloption/xxxxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1908

Fortinet Inc.
Get /system/local-properties/globaloption/{param}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 1909

Fortinet Inc.
Get /system/local-properties/hardware

Get /system/local-properties/hardware

Description

Queries hardware status and performance information.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/hardware

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1910

Fortinet Inc.
Get /system/local-properties/hardware

Sample Response

FortiNAC F 7.4.0 REST API 1911

Fortinet Inc.
Get /system/local-properties/hardware

{
"status": "string",
"errorMessage": "string",
"controlServer": {
"diskUsage": [
{
"name": "string",
"free": "string",
"total": "string",
"usage": 0
}
],
"memTotal": "string",
"memFree": "string",
"memUsage": 0,
"swapTotal": "string",
"swapFree": "string",
"swapUsage": 0,
"memSwapTotal": "string",
"memSwapFree": "string",
"memSwapUsage": 0,
"cpuUsage": "string",
"sizingTotal": "string",
"sizingFree": "string"
},
"applicationServer": {
"diskUsage": [
{
"name": "string",
"free": "string",
"total": "string",
"usage": 0
}
],
"memTotal": "string",
"memFree": "string",
"memUsage": 0,
"swapTotal": "string",
"swapFree": "string",
"swapUsage": 0,
"memSwapTotal": "string",
"memSwapFree": "string",
"memSwapUsage": 0,
"cpuUsage": "string",
"sizingTotal": "string",
"sizingFree": "string"
},
"diskFreeWarning": "string",
"diskFreeCritical": "string",
"memoryFreeWarning": "string",
"memoryFreeCritical": "string",
"networkTopologySizeWarning": "string",
"networkTopologySizeCritical": "string",
"masterDBID": 0,
"loaders": [
{
"name": "string",
"threadWarning": "string",
"threadCritical": "string",
"memoryWarning": "string",
FortiNAC F 7.4.0 REST API
"memoryCritical": "string", 1912
Fortinet Inc. "dbid": 0,
"threadCount": "string",
"totalMem": "string",
Get /system/local-properties/hardware

FortiNAC F 7.4.0 REST API 1913

Fortinet Inc.
Get /system/local-properties/hardware/performance

Get /system/local-properties/hardware/performance

Description

Queries hardware performance information only.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/hardware/performance

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1914

Fortinet Inc.
Get /system/local-properties/hardware/performance

Sample Response

{
"status": "string",
"errorMessage": "string",
"controlServer": {
"memTotal": "string",
"memFree": "string",
"swapTotal": "string",
"swapFree": "string",
"cpuUsage": "string",
"sizingTotal": "string",
"sizingFree": "string",
"fanSpeeds": [
[
"string"
]
],
"temperatures": [
[
"string"
]
],
"partitions": [
"string"
]
},
"applicationServer": {
"memTotal": "string",
"memFree": "string",
"swapTotal": "string",
"swapFree": "string",
"cpuUsage": "string",
"sizingTotal": "string",
"sizingFree": "string",
"fanSpeeds": [
[
"string"
]
],
"temperatures": [
[
"string"
]
],
"partitions": [
"string"
]
}
}

FortiNAC F 7.4.0 REST API 1915

Fortinet Inc.
Get /system/local-properties/license

Get /system/local-properties/license

Description

Returns the current license information for this server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/license

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1916

Fortinet Inc.
Get /system/local-properties/license

Sample Response

{
"status": "string",
"errorMessage": "string",
"inUseCount": 0,
"totalCount": 0,
"availCount": 0,
"usedPercent": 0,
"rtrInUseCount": 0,
"rtrTotalCount": 0,
"rtrAvailCount": 0,
"rtrUsedPercent": 0,
"concurrentLimitWarning": "string",
"concurrentLimitCritical": "string",
"masterDBID": 0,
"contracts": [
{
"code": "string",
"description": "string",
"expration": "2024-03-28",
"supportLevel": "string",
"supportDescription": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1917

Fortinet Inc.
Get /system/local-properties/license/concurrent

Get /system/local-properties/license/concurrent

Description

Returns the number of used licenses per device and summaries of the results

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

host Yes String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/license/concurrent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body host: xxxxxx

FortiNAC F 7.4.0 REST API 1918

Fortinet Inc.
Get /system/local-properties/license/concurrent

Sample Response

{
"status": "string",
"errorMessage": "string",
"usedByHost": 0,
"licensesUsed": 0,
"usedByDevices": 0,
"perDevice": [
{
"devType": "string",
"owner": "string",
"mac": "string",
"ip": "string",
"name": "string",
"views": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1919

Fortinet Inc.
Get /system/local-properties/software-details

Get /system/local-properties/software-details

Description

Returns the current version and system information for this server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/local-

properties/software-details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1920

Fortinet Inc.
Get /system/local-properties/software-details

Sample Response

{
"status": "string",
"errorMessage": "string",
"productName": "string",
"productCopyright": "string",
"productVersion": "string",
"productBuildLabel": "string",
"apiVersion": "string",
"hostName": "string",
"isNCM": true,
"isNCMPod": true,
"isRemote": true,
"firstProductVersion": "string",
"os": "string"
}

FortiNAC F 7.4.0 REST API 1921

Fortinet Inc.
Post /system/local-properties/cluster/application/primary/restart

Post /system/local-
properties/cluster/application/primary/restart

Description

Restarts the Primary Application server in this cluster.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/cluster/application/primary/restart

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1922

Fortinet Inc.
Post /system/local-properties/cluster/application/primary/restart

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1923

Fortinet Inc.
Post /system/local-properties/cluster/control/primary/restart

Post /system/local-properties/cluster/control/primary/restart

Description

Restarts the Primary Control server in this cluster.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/cluster/control/primary/restart

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1924

Fortinet Inc.
Post /system/local-properties/cluster/control/primary/restart

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1925

Fortinet Inc.
Post /system/local-properties/hardware/thresholds

Post /system/local-properties/hardware/thresholds

Description

Set the hardware performance thresholds, providing warnings for high utilization.

Request Parameter

systemID, the hardware system ID. (Integer)

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

warningAttrName Optional String

warningAttrVal Optional String

criticalAttrName Optional String

criticalAttrVal Optional String

FortiNAC F 7.4.0 REST API 1926

Fortinet Inc.
Post /system/local-properties/hardware/thresholds

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/hardware/thresholds

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body systemID: xxxxxxx

warningAttrName: xxxxxxx
warningAttrVal: xxxxxx
criticalAttrName: xxxxxxx
criticalAttrVal: xxxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1927

Fortinet Inc.
Post /system/local-properties/license/apply

Post /system/local-properties/license/apply

Description

Applies a new license key to this appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

licenseKey Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/hardware/thresholds

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body licenseKey: xxxxxxxx

FortiNAC F 7.4.0 REST API 1928

Fortinet Inc.
Post /system/local-properties/license/apply

Sample Response

{
"status": "string",
"errorMessage": "string",
"isLegacyKey": true,
"isValidKey": true,
"validLicenseCount": true,
"isKeyApplicationServer": true,
"isKeyManagerServer": true
}

FortiNAC F 7.4.0 REST API 1929

Fortinet Inc.
Post /system/local-properties/passwords/change

Post /system/local-properties/passwords/change

Description

Changes the previously configured passwords for the appliance.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/passwords/change

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"csAdminCLIPassword": {
"oldPassword": "string",
"newPassword": "string"
},
"asAdminCLIPassword": {
"oldPassword": "string",
"newPassword": "string"
},
"csRootCLIPassword": {
"oldPassword": "string",
"newPassword": "string"
},
"asRootCLIPassword": {
"oldPassword": "string",
"newPassword": "string"

FortiNAC F 7.4.0 REST API 1930

Fortinet Inc.
Post /system/local-properties/passwords/change

}
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1931

Fortinet Inc.
Post /system/local-properties/system/initialize

Post /system/local-properties/system/initialize

Description

Sets initial passwords for the CLI and the Administrative UI and configures the NMAP service. This does not change the
CLI passwords immediately, as the final values are written by the Config Wizard.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/local-

properties/system/initialize

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"adminUIUserID": "string",
"adminUIPassword": "string",
"adminCLIPassword": "string",
"rootCLIPassword": "string",
"nmapScanning": true
}

FortiNAC F 7.4.0 REST API 1932

Fortinet Inc.
Post /system/local-properties/system/initialize

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1933

Fortinet Inc.
Vendor OUI

Vendor OUI

FortiNAC F 7.4.0 REST API 1934

Fortinet Inc.
Delete /settings/integration/vendor-oui/{id}

Delete /settings/integration/vendor-oui/{id}

Description

Deletes the Vendor OUI record supplied, if it is not currently in use.

Request Parameter

Id, the Vendor OUI record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/vendor-oui/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1935

Fortinet Inc.
Delete /settings/integration/vendor-oui/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1936

Fortinet Inc.
Get /settings/integration/vendor-oui

Get /settings/integration/vendor-oui

Description

Returns all Vendor OUI records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vendor-oui

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1937

Fortinet Inc.
Get /settings/integration/vendor-oui

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1938

Fortinet Inc.
Get /settings/integration/vendor-oui/count

Get /settings/integration/vendor-oui/count

Description

Returns a count of Vendor OUI records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1939

Fortinet Inc.
Get /settings/integration/vendor-oui/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1940

Fortinet Inc.
Get /settings/integration/vendor-oui/count/all

Get /settings/integration/vendor-oui/count/all

Description

Returns the count of all Vendor OUI records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1941

Fortinet Inc.
Get /settings/integration/vendor-oui/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1942

Fortinet Inc.
Get /settings/integration/vendor-oui/count/{id}

Get /settings/integration/vendor-oui/count/{id}

Description

Returns the Vendor OUI record with the supplied DBID.

Request Parameter

Id, the Vendor OUI record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/count/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1943

Fortinet Inc.
Get /settings/integration/vendor-oui/count/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1944

Fortinet Inc.
Get /settings/integration/vendor-oui/supporting-info

Get /settings/integration/vendor-oui/supporting-info

Description

Returns the list of Roles and Registration Types used to edit Vendor OUIs.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1945

Fortinet Inc.
Get /settings/integration/vendor-oui/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"regTypes": [
{
"first": "string",
"second": "string"
}
],
"roles": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1946

Fortinet Inc.
Post /settings/integration/vendor-oui

Post /settings/integration/vendor-oui

Description

Adds a new Vendor OUI record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vendor-oui

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}

FortiNAC F 7.4.0 REST API 1947

Fortinet Inc.
Post /settings/integration/vendor-oui

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 1948

Fortinet Inc.
Post /settings/integration/vendor-oui/delete

Post /settings/integration/vendor-oui/delete

Description

Deletes the Vendor OUI record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6

FortiNAC F 7.4.0 REST API 1949

Fortinet Inc.
Post /settings/integration/vendor-oui/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1950

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}/delete

Post /settings/integration/vendor-oui/{id}/delete

Description

Deletes the Vendor OUI record supplied, if it is not currently in use.

Request Parameter

Id, the Vendor OUI record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vendor-

oui/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1951

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1952

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}

Post /settings/integration/vendor-oui/{id}

Description

Updates an existing Vendor OUI record in the database.

Request Parameter

Id, the Vendor OUI record id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vendor-oui/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"vendorCode": "string",
"vendorName": "string",
"vendorAlias": "string",
"description": "string",
"role": "string",
"registrationType": "string",
"userRegistrationType": "string"
}

FortiNAC F 7.4.0 REST API 1953

Fortinet Inc.
Post /settings/integration/vendor-oui/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 1954

Fortinet Inc.
Network Address

Network Address

FortiNAC F 7.4.0 REST API 1955

Fortinet Inc.
Get /settings/device/network-address

Get /settings/device/network-address

Description

Returns a list of Address records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/network-

address

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1956

Fortinet Inc.
Get /settings/device/network-address

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-05-03T23:09:36.168Z",
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1957

Fortinet Inc.
Get /settings/device/network-address/{id}

Get /settings/device/network-address/{id}

Description

Returns a list of Address records matching the supplied filter.

Request Parameter

Id, the id of the network address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/network-

address/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1958

Fortinet Inc.
Get /settings/device/network-address/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-13T18:14:09.718Z",
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1959

Fortinet Inc.
Get /settings/device/network-address/{id}/usage

Get /settings/device/network-address/{id}/usage

Description

Returns a list of records that reference this Address record.

Request Parameter

Id, the id of the network address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/device/network-

address/5/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1960

Fortinet Inc.
Get /settings/device/network-address/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1961

Fortinet Inc.
Post /settings/device/network-address/delete

Post /settings/device/network-address/delete

Description

Deletes a list of Address records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:4

FortiNAC F 7.4.0 REST API 1962

Fortinet Inc.
Post /settings/device/network-address/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1963

Fortinet Inc.
Post /settings/device/network-address/{id}

Post /settings/device/network-address/{id}

Description

Updates an Address record.

Request Parameter

Id, the id of the network address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}

FortiNAC F 7.4.0 REST API 1964

Fortinet Inc.
Post /settings/device/network-address/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1965

Fortinet Inc.
Post /settings/device/network-address/{id}/delete

Post /settings/device/network-address/{id}/delete

Description

Deletes a single Address record by ID.

Request Parameter

Id, the id of the network address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address/5/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1966

Fortinet Inc.
Post /settings/device/network-address/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1967

Fortinet Inc.
Post /settings/device/network-address

Post /settings/device/network-address

Description

Creates a new Address record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}

FortiNAC F 7.4.0 REST API 1968

Fortinet Inc.
Post /settings/device/network-address

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1969

Fortinet Inc.
Delete /settings/device/network-address/{id}

Delete /settings/device/network-address/{id}

Description

Deletes a single Address record by ID.

Request Parameter

Id, the id of the network address.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/device/network-

address/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1970

Fortinet Inc.
Delete /settings/device/network-address/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1971

Fortinet Inc.
Network Address Group

Network Address Group

FortiNAC F 7.4.0 REST API 1972

Fortinet Inc.
Get /settings/device/network-address-group/{id}

Get /settings/device/network-address-group/{id}

Description

Returns a list of Address records matching the supplied filter.

Request Parameter

Id, the id of the network address group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1973

Fortinet Inc.
Get /settings/device/network-address-group/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-13T19:46:39.608Z",
"dbid": 0,
"name": "string",
"note": "string",
"addresses": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-
13T19:46:39.608Z",
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1974

Fortinet Inc.
Get /settings/device/network-address-group

Get /settings/device/network-address-group

Description

Returns a list of Address records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/network-

address-group

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1975

Fortinet Inc.
Get /settings/device/network-address-group

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-13T19:46:39.608Z",
"dbid": 0,
"name": "string",
"note": "string",
"addresses": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2023-12-
13T19:46:39.608Z",
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
]
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 1976

Fortinet Inc.
Get /settings/device/network-address-group/{id}/usage

Get /settings/device/network-address-group/{id}/usage

Description

Returns a list of records that reference this Address record.

Request Parameter

Id, the id of the network address group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/4/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1977

Fortinet Inc.
Get /settings/device/network-address-group/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1978

Fortinet Inc.
Post /settings/device/network-address-group/delete

Post /settings/device/network-address-group/delete

Description

Deletes a list of Address records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Yes Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 1979

Fortinet Inc.
Post /settings/device/network-address-group/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1980

Fortinet Inc.
Post /settings/device/network-address-group/{id}/delete

Post /settings/device/network-address-group/{id}/delete

Description

Deletes a single Address record by ID.

Request Parameter

Id, the id of the network address group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/4/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1981

Fortinet Inc.
Post /settings/device/network-address-group/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1982

Fortinet Inc.
Post /settings/device/network-address-group/{id}

Post /settings/device/network-address-group/{id}

Description

Updates an Address record.

Request Parameter

Id, the id of the network address group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"note": "string",
"addresses": [
{
"dbid": 0,
"name": "string",
"type": "string",

FortiNAC F 7.4.0 REST API 1983

Fortinet Inc.
Post /settings/device/network-address-group/{id}

"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
]
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1984

Fortinet Inc.
Post /settings/device/network-address-group

Post /settings/device/network-address-group

Description

Creates a new Address record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/network-

address-gropup

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"note": "string",
"addresses": [
{
"dbid": 0,
"name": "string",
"type": "string",
"startAddress": "string",
"endAddress": "string",
"addressLookup": "string",
"sdnServiceConnectorID": 0,
"clearpassSPT": "string"
}
]
}

FortiNAC F 7.4.0 REST API 1985

Fortinet Inc.
Post /settings/device/network-address-group

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 1986

Fortinet Inc.
Delete /settings/device/network-address-group/{id}

Delete /settings/device/network-address-group/{id}

Description

Deletes a single Address record by ID.

Request Parameter

Id, the id of the network address group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/device/network-

address-group/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1987

Fortinet Inc.
Delete /settings/device/network-address-group/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 1988

Fortinet Inc.
Network Device

Network Device

FortiNAC F 7.4.0 REST API 1989

Fortinet Inc.
Get /device/count

Get /device/count

Description

Returns the Network Device record matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1990

Fortinet Inc.
Get /device/count

Sample Response

FortiNAC F 7.4.0 REST API 1991

Fortinet Inc.
Get /device/count

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-13T22:33:42.093Z",
"lastSuccessfulPoll": "2023-12-
13T22:33:42.093Z",
"mibs": [
"string"
],
"deviceType": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
FortiNAC F 7.4.0 "landscape":
REST API 0, 1992
Fortinet Inc. "id": 0,
"state": "string",
"name": "string",
Get /device/count

FortiNAC F 7.4.0 REST API 1993

Fortinet Inc.
Get /device/{id}

Get /device/{id}

Description

Returns the Network Device record with the supplied DBID.

Parameter

Id, the network device ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1994

Fortinet Inc.
Get /device/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1995

Fortinet Inc.
Get /device/{id}

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-13T22:33:42.093Z",
"lastSuccessfulPoll": "2023-12-
13T22:33:42.093Z",
"mibs": [
"string"
],
"deviceType": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
FortiNAC F 7.4.0 "landscape":
REST API 0, 1996
Fortinet Inc. "id": 0,
"state": "string",
"name": "string",
Get /device/{id}

FortiNAC F 7.4.0 REST API 1997

Fortinet Inc.
Get /device/monitor/{id}

Get /device/monitor/{id}

Description

Gets all changes to Network Device records since the Events were last polled.

Request Parameter

Id, the id of the network device record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/monitor/12

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 1998

Fortinet Inc.
Get /device/monitor/{id}

Sample Response

FortiNAC F 7.4.0 REST API 1999

Fortinet Inc.
Get /device/monitor/{id}

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-14T23:29:41.659Z",
"lastSuccessfulPoll": "2023-12-
14T23:29:41.659Z",
"mibs": [
"string"
],
"sysOid": "string",
"attribute": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"attributeNames": [
"string"
],
"identification": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
FortiNAC F 7.4.0 REST API
"requestString": "string", 2000
Fortinet Inc. "domainName": "string",
"packedVersion": 0,
"creationEvent": {
Get /device/monitor/{id}

FortiNAC F 7.4.0 REST API 2001

Fortinet Inc.
Get /device/count/all

Get /device/count/all

Description

Returns the count of all Network Device records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2002

Fortinet Inc.
Get /device/count/all

Sample Response

FortiNAC F 7.4.0 REST API 2003

Fortinet Inc.
Get /device/count/all

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-13T22:33:42.093Z",
"lastSuccessfulPoll": "2023-12-
13T22:33:42.093Z",
"mibs": [
"string"
],
"deviceType": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:33:42.093Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
FortiNAC F 7.4.0 "landscape":
REST API 0, 2004
Fortinet Inc. "id": 0,
"state": "string",
"name": "string",
Get /device/count/all

FortiNAC F 7.4.0 REST API 2005

Fortinet Inc.
Get /device

Get /device

Description

Returns all Network Device records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2006

Fortinet Inc.
Get /device

Sample Response

FortiNAC F 7.4.0 REST API 2007

Fortinet Inc.
Get /device

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-13T22:25:16.866Z",
"lastSuccessfulPoll": "2023-12-
13T22:25:16.866Z",
"mibs": [
"string"
],
"deviceType": "string",
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:25:16.866Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2023-12-13T22:25:16.867Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
FortiNAC F 7.4.0 "landscape":
REST API 0, 2008
Fortinet Inc. "id": 0,
"state": "string",
"name": "string",
Get /device

FortiNAC F 7.4.0 REST API 2009

Fortinet Inc.
Get /device/{id}/usage

Get /device/{id}/usage

Description

Returns a list of Network Device records that reference this record.

Request Parameter

Id, the id of the network device record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/device/5/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2010

Fortinet Inc.
Get /device/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2011

Fortinet Inc.
Get /device/polling/l3

Get /device/polling/l3

Description

Sets the L3 polling properties for the supplied devices.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

enabled Optional boolean

createRogues Optional boolean

frequencySeconds Optional integer

priority Optional integer

id Optional id

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/polling/l3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2012

Fortinet Inc.
Get /device/polling/l3

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2013

Fortinet Inc.
Get /device/certificate/{id}

Get /device/certificate/{id}

Description

Returns the SSL certificate for the device.

Request Parameter

Id, the SSL certificate Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/certificate/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2014

Fortinet Inc.
Get /device/certificate/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"cert": {
"name": "string",
"pathLabel": "string",
"requiresRestart": true,
"trustedCert": true,
"pendingCertDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"pendingCertPrivateKey": "string",
"privateKey": "string",
"alias": "string",
"issuedTo": "string",
"issuedBy": "string",
"expiration": 0,
"status": "string",
"certificateDetails": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"certificateChain": [
{}
]
}
}

FortiNAC F 7.4.0 REST API 2015

Fortinet Inc.
Get /device/move

Get /device/move

Description

Moves an existing Network Device from one container to other.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

isHost Optional Boolean

containerID Optional Integer

deviceID Optional Array

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/move

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body isHOst: "xxxxxxxxxxxxxx"

containerID: "xxxxxxxxxxxxxx"
deviceID: "xxxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2016

Fortinet Inc.
Get /device/move

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2017

Fortinet Inc.
Get /device/properties

Get /device/properties

Description

Returns the currently configured network device settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2018

Fortinet Inc.
Get /device/properties

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"agentDelayStr": "string",
"minTrapPeriodStr": "string",
"maxTrapPeriodsStr": "string",
"coldWarmTrapDelayStr": "string",
"regDelayStr": "string",
"uplinkCountStr": "string",
"telnetTimeoutStr": "string",
"vlanResetDelayStr": "string",
"vlanSwitchingDelayStr": "string",
"macSpoofDelayStr": "string",
"multiAccessStr": "string",
"multiAccessThreshold": "string",
"ciscoDiscoveryStr": "string",
"lldpDiscoveryStr": "string",
"cdpMaxHopsStr": "string",
"ignoreMacNotifyOnPhoneStr": "string",
"meAccessPolicy": "string",
"preservePortNamesStr": "string",
"telnetTimeout": "string",
"preservePortNames": "string",
"vlanSwitchingDelay": "string",
"agentDelay": "string",
"minTrapPeriod": "string",
"getmaxTrapPeriods": "string",
"coldWarmTrapDelay": "string",
"regDelay": "string",
"uplinkCount": "string",
"vlanResetDelay": "string",
"macSpoofDelay": "string",
"multiAccess": "string",
"ciscoDiscovery": "string",
"lldpDiscovery": "string",
"ciscoDiscoveryMaxHops": "string",
"ignoreMacNotifyOnPhone": "string"
}
}

FortiNAC F 7.4.0 REST API 2019

Fortinet Inc.
Post /device/delete

Post /device/delete

Description

Deletes the Network Device record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2020

Fortinet Inc.
Post /device/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2021

Fortinet Inc.
Post /device/certificate/{id}/import

Post /device/certificate/{id}/import

Description

Imports the certificate chain presented by the device.

Request Parameter

Id, the SSL certificate Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/certificate/1/import

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"caCertsOnly": true
}

FortiNAC F 7.4.0 REST API 2022

Fortinet Inc.
Post /device/certificate/{id}/import

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2023

Fortinet Inc.
Post /device/certificate/poll/l2

Post /device/certificate/poll/l2

Description

Executes an L2 poll for the supplied devices.

Request Parameter

Id, the device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/certificate/poll/l2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2024

Fortinet Inc.
Post /device/certificate/poll/l2

Request Body id: 6

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2025

Fortinet Inc.
Post /device/certificate/poll/l3

Post /device/certificate/poll/l3

Description

Executes an L3 poll for the supplied devices.

Request Parameter

Id, the device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/certificate/poll/l3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2026

Fortinet Inc.
Post /device/certificate/poll/l3

Request Body id: 7

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2027

Fortinet Inc.
Post /device/remove-attribute/{id}

Post /device/remove-attribute/{id}

Description

Removes an existing device attribute from the database.

Request Parameter

Id, the device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

attrName Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/remove-attribute/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2028

Fortinet Inc.
Post /device/remove-attribute/{id}

Request Body attrName: "access-point"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2029

Fortinet Inc.
Post /device/resync-interfaces

Post /device/resync-interfaces

Description

Resync Interfaces for the supplied devices.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/resync-interfaces

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 2030

Fortinet Inc.
Post /device/resync-interfaces

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2031

Fortinet Inc.
Post /device/update-attribute/{id}

Post /device/update-attribute/{id}

Description

Adds or modifies a device attribute from the database.

Request Parameter

Id, the device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

attrName Required String

attrValue Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/update-attribute/3

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2032

Fortinet Inc.
Post /device/update-attribute/{id}

Content-Type: application/json

Request Body attrName: ""

attrValue :""

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2033

Fortinet Inc.
Post /device/virtualized-devices/{id}

Post /device/virtualized-devices/{id}

Description

Returns a summary of all virtualized devices associated with the supplied device.

Request Parameter

Id, the virtualized device Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/virtualized-

devices/8

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2034

Fortinet Inc.
Post /device/virtualized-devices/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": [
{
"id": 0,
"name": "string",
"img": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2035

Fortinet Inc.
Post /device/{id}/delete

Post /device/{id}/delete

Description

Deletes the Network Device record or records supplied, if it is not currently in use.

Request Parameter

Id, the id of the network device record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/3/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2036

Fortinet Inc.
Post /device/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2037

Fortinet Inc.
Post /device/monitor/{id}/stop

Post /device/monitor/{id}/stop

Description

Stops collecting changes made to Network Device records for the specified monitor.

Request Parameter

Id, the id of the network device record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/monitor/7/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2038

Fortinet Inc.
Post /device/monitor/{id}/stop

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2039

Fortinet Inc.
Post /device/monitor/start

Post /device/monitor/start

Description

Begins collecting changes made to Network Device records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2040

Fortinet Inc.
Post /device/monitor/start

Sample Response

FortiNAC F 7.4.0 REST API 2041

Fortinet Inc.
Post /device/monitor/start

{
"status": "string",
"errorMessage": "string",
"total": 0,
"monitorID": 0,
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2023-12-14T23:16:57.811Z",
"lastSuccessfulPoll": "2023-12-
14T23:16:57.811Z",
"mibs": [
"string"
],
"sysOid": "string",
"attribute": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"attributeNames": [
"string"
],
"identification": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"requestString": "string",
FortiNAC F 7.4.0 REST API
"domainName": "string", 2042
Fortinet Inc. "packedVersion": 0,
"creationEvent": {
"landscape": 0,
Post /device/monitor/start

FortiNAC F 7.4.0 REST API 2043

Fortinet Inc.
Post /device/pingable/{id}

Post /device/pingable/{id}

Description

Updates an existing pingable device in the database.

Parameter

Id, the network device ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/pingable/7

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"containerID": 0,
"name": "string",
"ipAddress": "string",
"macAddress": "string",
"description": "string",
"note": "string",
"deviceType": "string",
"role": "string",

FortiNAC F 7.4.0 REST API 2044

Fortinet Inc.
Post /device/pingable/{id}

"incomingEventCategory": "string",
"incomingEventParser": "string",
"statusPolling": true,
"statusPollInterval": 0,
"ssoAgentType": "string",
"ibossPort": 0,
"ibossKey": "string",
"ibossDomain": "string",
"ssoCustomScript": "string",
"paloAltoPort": 0,
"paloAltoDomain": "string",
"paloAltoIntegratedAgent": true,
"paloAltoAPIKey": "string",
"radiusAccountingPort": 0,
"radiusSecret": "string",
"ssoGroupID": 0,
"machineName": "string",
"department": "string",
"machineOwner": "string",
"administrativeContact": "string",
"geographicalLocation": "string",
"businessPurpose": "string",
"bootpAddress": "string",
"printQueue": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2045

Fortinet Inc.
Post /device/pingable

Post /device/pingable

Description

Adds a new pingable device to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/pingable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"containerID": 0,
"name": "string",
"ipAddress": "string",
"macAddress": "string",
"description": "string",
"note": "string",
"deviceType": "string",
"role": "string",
"incomingEventCategory": "string",
"incomingEventParser": "string",
"statusPolling": true,
"statusPollInterval": 0,
"ssoAgentType": "string",
"ibossPort": 0,
"ibossKey": "string",
"ibossDomain": "string",

FortiNAC F 7.4.0 REST API 2046

Fortinet Inc.
Post /device/pingable

"ssoCustomScript": "string",
"paloAltoPort": 0,
"paloAltoDomain": "string",
"paloAltoIntegratedAgent": true,
"paloAltoAPIKey": "string",
"radiusAccountingPort": 0,
"radiusSecret": "string",
"ssoGroupID": 0,
"machineName": "string",
"department": "string",
"machineOwner": "string",
"administrativeContact": "string",
"geographicalLocation": "string",
"businessPurpose": "string",
"bootpAddress": "string",
"printQueue": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
"result": []
}

FortiNAC F 7.4.0 REST API 2047

Fortinet Inc.
Post /device/properties

Post /device/properties

Description

Sets the properties for a Network Device.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

agentDelay Yes String

agentDelayStr Yes String

cdpMaxHopsStr Yes String

ciscoDiscovery Yes String

ciscoDiscoveryMaxHops Yes String

ciscoDiscoveryStr Yes String

coldWarmTrapDelay Yes String

coldWarmTrapDelayStr Yes String

getmaxTrapPeriods Yes String

ignoreMacNotifyOnPhone Yes String

ignoreMacNotifyOnPhoneStr Yes String

FortiNAC F 7.4.0 REST API 2048

Fortinet Inc.
Post /device/properties

Name Required Type

lldpDiscovery Yes String

lldpDiscoveryStr Yes String

macSpoofDelay Yes String

macSpoofDelayStr Yes String

maxTrapPeriodsStr Yes String

meAccessPolicy Yes String

minTrapPeriod Yes String

minTrapPeriodStr Yes String

multiAccess Yes String

multiAccessStr Yes String

multiAccessThreshold Yes String

preservePortNames Yes String

preservePortNamesStr Yes String

regDelay Yes String

regDelayStr Yes String

telnetTimeout Yes String

telnetTimeoutStr Yes String

uplinkCount Yes String

uplinkCountStr Yes String

vlanResetDelay Yes String

vlanResetDelayStr Yes String

vlanSwitchingDelay Yes String

vlanSwitchingDelayStr Yes String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body agentDelay: "xxxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2049

Fortinet Inc.
Post /device/properties

agentDelayStr: "xxxxxxxxxxxxxx"
cdpMaxHopsStr: "xxxxxxxxxxxxxx"
ciscoDiscovery: "xxxxxxxxxxxxxx"
ciscoDiscoveryMaxHops: "xxxxxxxxxxxxxx"
ciscoDiscoveryStr: "xxxxxxxxxxxxxx"
coldWarmTrapDelay: "xxxxxxxxxxxxxx"
coldWarmTrapDelayStr: "xxxxxxxxxxxxxx"
getmaxTrapPeriods: "xxxxxxxxxxxxxx"
ignoreMacNotifyOnPhone: "xxxxxxxxxxxxxx"
ignoreMacNotifyOnPhoneStr: "xxxxxxxxxxxxxx"
lldpDiscovery: "xxxxxxxxxxxxxx"
lldpDiscoveryStr: "xxxxxxxxxxxxxx"
macSpoofDelay: "xxxxxxxxxxxxxx"
macSpoofDelayStr: "xxxxxxxxxxxxxx"
maxTrapPeriodsStr: "xxxxxxxxxxxxxx"
meAccessPolicy: "xxxxxxxxxxxxxx"
minTrapPeriod: "xxxxxxxxxxxxxx"
minTrapPeriodStr: "xxxxxxxxxxxxxx"
multiAccess: "xxxxxxxxxxxxxx"
multiAccessStr: "xxxxxxxxxxxxxx"
multiAccessThreshold: "xxxxxxxxxxxxxx"
preservePortNames: "xxxxxxxxxxxxxx"
preservePortNamesStr: "xxxxxxxxxxxxxx"
regDelay: "xxxxxxxxxxxxxx"
regDelayStr: "xxxxxxxxxxxxxx"
telnetTimeout: "xxxxxxxxxxxxxx"
telnetTimeoutStr: "xxxxxxxxxxxxxx"
uplinkCount: "xxxxxxxxxxxxxx"
uplinkCountStr: "xxxxxxxxxxxxxx"
vlanResetDelay: "xxxxxxxxxxxxxx"
vlanResetDelayStr: "xxxxxxxxxxxxxx"
vlanSwitchingDelay: "xxxxxxxxxxxxxx"
vlanSwitchingDelayStr: "xxxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2050

Fortinet Inc.
Post /device/properties

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"agentDelayStr": "string",
"minTrapPeriodStr": "string",
"maxTrapPeriodsStr": "string",
"coldWarmTrapDelayStr": "string",
"regDelayStr": "string",
"uplinkCountStr": "string",
"telnetTimeoutStr": "string",
"vlanResetDelayStr": "string",
"vlanSwitchingDelayStr": "string",
"macSpoofDelayStr": "string",
"multiAccessStr": "string",
"multiAccessThreshold": "string",
"ciscoDiscoveryStr": "string",
"lldpDiscoveryStr": "string",
"cdpMaxHopsStr": "string",
"ignoreMacNotifyOnPhoneStr": "string",
"meAccessPolicy": "string",
"preservePortNamesStr": "string",
"telnetTimeout": "string",
"preservePortNames": "string",
"vlanSwitchingDelay": "string",
"agentDelay": "string",
"minTrapPeriod": "string",
"getmaxTrapPeriods": "string",
"coldWarmTrapDelay": "string",
"regDelay": "string",
"uplinkCount": "string",
"vlanResetDelay": "string",
"macSpoofDelay": "string",
"multiAccess": "string",
"ciscoDiscovery": "string",
"lldpDiscovery": "string",
"ciscoDiscoveryMaxHops": "string",
"ignoreMacNotifyOnPhone": "string"
}
}

FortiNAC F 7.4.0 REST API 2051

Fortinet Inc.
Post /device/snmp

Post /device/snmp

Description

Adds a new SNMP device to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/snmp

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"containerID": 0,
"ipAddress": "string",
"snmpProtocol": "string",
"snmpSecurityStrings": [
"string"
],
"snmpUsername": "string",
"snmpAuthenticationProtocol": "string",
"snmpAuthenticationPassword": "string",
"snmpPrivacyProtocol": "string",
"snmpPrivacyPassword": "string",
"cliCredentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",

FortiNAC F 7.4.0 REST API 2052

Fortinet Inc.
Post /device/snmp

"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2053

Fortinet Inc.
Post /device/snmp/{id}

Post /device/snmp/{id}

Description

Updates an existing SNMP device in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/snmp/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"containerID": 0,
"ipAddress": "string",
"snmpProtocol": "string",
"snmpSecurityStrings": [
"string"
],
"snmpUsername": "string",
"snmpAuthenticationProtocol": "string",
"snmpAuthenticationPassword": "string",
"snmpPrivacyProtocol": "string",
"snmpPrivacyPassword": "string",
"cliCredentials": {
"version": 0,
"userName": "string",
"password": "string",
"enablePassword": "string",

FortiNAC F 7.4.0 REST API 2054

Fortinet Inc.
Post /device/snmp/{id}

"port": "string",
"sessionType": "string",
"sessionTypeStr": "string"
},
"vlanSwitchingEnabled": true,
"paOptimzationEnabled": true,
"macFilteringEnabled": true,
"role": "string",
"description": "string",
"note": "string",
"manageAsGenericSNMP": true,
"readL2L3UsingSNMP": true,
"deviceTypeOverride": "string",
"incomingEventCategory": "string",
"incomingEventParser": "string",
"statusPolling": true,
"statusPollInterval": 0,
"ssoAgentType": "string",
"ibossPort": 0,
"ibossKey": "string",
"ibossDomain": "string",
"ssoCustomScript": "string",
"paloAltoPort": 0,
"paloAltoDomain": "string",
"paloAltoIntegratedAgent": true,
"paloAltoAPIKey": "string",
"radiusAccountingPort": 0,
"radiusSecret": "string",
"ssoGroupID": 0,
"systemName": "string",
"contactName": "string",
"deviceLocation": "string",
"contactPollingEnabled": true,
"contactPollingInterval": 0,
"l2PollingEnabled": true,
"l2PollingInterval": 0,
"l3PollingEnabled": true,
"l3PollingInterval": 0,
"l3PollingPriority": 0,
"cdpPollingEnabled": true,
"cdpPollingInterval": 0
}

FortiNAC F 7.4.0 REST API 2055

Fortinet Inc.
Post /device/snmp/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2056

Fortinet Inc.
Delete /device/{id}

Delete /device/{id}

Description

Deletes the Network Device record supplied, if it is not currently in use.

Parameter

Id, the network device ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/device/9

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2057

Fortinet Inc.
Delete /device/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2058

Fortinet Inc.
OS Update

OS Update

FortiNAC F 7.4.0 REST API 2059

Fortinet Inc.
Get /settings/udpates/os-updates

Get /settings/udpates/os-updates

Description

Returns the OS Update Servers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/udpates/os-

updates

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2060

Fortinet Inc.
Get /settings/udpates/os-updates

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"ip": "string",
"concurrentLicenses": "string",
"rtrLicenses": "string",
"highAvail": "string",
"remoteRadius": "string",
"deviceProfiler": "string",
"guestManager": "string",
"wirelessOnly": "string",
"integrationSuite": "string",
"endpointCompliance": "string",
"licenseName": "string",
"expDate": "string",
"serial": "string",
"mac": "string",
"serverType": "string",
"uuid": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2061

Fortinet Inc.
Get /settings/udpates/os-updates/logs

Get /settings/udpates/os-updates/logs

Description

Returns the OS Update Servers logs.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/udpates/os-

updates/logs

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2062

Fortinet Inc.
Get /settings/udpates/os-updates/logs

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2063

Fortinet Inc.
Get /settings/udpates/os-updates/update-data

Get /settings/udpates/os-updates/update-data

Description

Returns the OS Update data.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/udpates/os-

updates/update-data

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2064

Fortinet Inc.
Get /settings/udpates/os-updates/update-data

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"statusList": [
{
"status": "string",
"host": "string",
"product": "string",
"lastUpdateStart": "string",
"lastUpdateStatus": "string",
"lastUpdateTime": "string"
}
],
"hasUpdate": true,
"hasError": true,
"hasInProgress": true,
"status": "string",
"upToDate": true
}
}

FortiNAC F 7.4.0 REST API 2065

Fortinet Inc.
PA Packet Transport Config

PA Packet Transport Config

FortiNAC F 7.4.0 REST API 2066

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config

Get /settings/agent/pa-packet-transport-config

Description

Returns a list of Persistent Agent Transport records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2067

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:55.000+0000",
"id": 1,
"name": "Default TCP",
"port": 4568,
"tlsConfigID": 3,
"enabled": true,
"transportType": "TCP",
"maxPacketQueueSize": 10000,
"bindToAddress": null,
"writeIdleTimeout": 30,
"readIdleTimeout": 60,
"useNativeTransport": false,
"maxConcurrentConnections": 2147483647,
"globalModifiedDate": "2023-08-
25T17:40:55.000+0000",
"GUID": null,
"tlsConfigName": "Default TCP"
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 2068

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/{id}/usage

Get /settings/agent/pa-packet-transport-config/{id}/usage

Description

Returns a list of Persistent Agent Transport records that reference this record.

Request Parameter

Id, the DBID of the persistent agent transport record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2069

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null
"result": []
}

FortiNAC F 7.4.0 REST API 2070

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/performance

Get /settings/agent/pa-packet-transport-
config/performance

Description

Reinitialize Persistent Agent Transports from the configurations in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/performance

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2071

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/performance

Sample Response

{
"status": "success",
"errorMessage": null
"result": []
}

FortiNAC F 7.4.0 REST API 2072

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/{id}

Get /settings/agent/pa-packet-transport-config/{id}

Description

Returns a list of Persistent Agent Transport records matching the supplied filter.

Request Parameter

Id, the DBID of the persistent agent transport record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2073

Fortinet Inc.
Get /settings/agent/pa-packet-transport-config/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:55.000+0000",
"id": 1,
"name": "Default TCP",
"port": 4568,
"tlsConfigID": 3,
"enabled": true,
"transportType": "TCP",
"maxPacketQueueSize": 10000,
"bindToAddress": null,
"writeIdleTimeout": 30,
"readIdleTimeout": 60,
"useNativeTransport": false,
"maxConcurrentConnections": 2147483647,
"globalModifiedDate": "2023-08-
25T17:40:55.000+0000",
"GUID": null,
"tlsConfigName": "Default TCP"
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 2074

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config

Post /settings/agent/pa-packet-transport-config

Description

Creates a new Persistent Agent Transport record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"transportType": "string",
"tlsConfigID": 0,
"tlsConfigName": "string",
"id": 0,
"name": "string",
"port": 0,
"enabled": true,
"maxPacketQueueSize": 0,
"bindToAddress": "string",
"writeIdleTimeout": 0,
"readIdleTimeout": 0,
"useNativeTransport": true,
"maxConcurrentConnections": 0,
"globalModifiedDate": "2023-12-19T23:36:45.704Z",

FortiNAC F 7.4.0 REST API 2075

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config

"gUID": 0
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2076

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/delete

Post /settings/agent/pa-packet-transport-config/delete

Description

Deletes a list of Persistent Agent Transport records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2077

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2078

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/{id}

Post /settings/agent/pa-packet-transport-config/{id}

Description

Updates an Persistent Agent Transport record.

Request Parameter

Id, the DBID of the persistent agent transport record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"transportType": "string",
"tlsConfigID": 0,
"tlsConfigName": "string",
"id": 0,
"name": "string",
"port": 0,
"enabled": true,
"maxPacketQueueSize": 0,

FortiNAC F 7.4.0 REST API 2079

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/{id}

"bindToAddress": "string",
"writeIdleTimeout": 0,
"readIdleTimeout": 0,
"useNativeTransport": true,
"maxConcurrentConnections": 0,
"globalModifiedDate": "2023-12-19T23:36:45.704Z",
"gUID": 0
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2080

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/{id}/delete

Post /settings/agent/pa-packet-transport-config/{id}/delete

Description

Deletes a single Persistent Agent Transport record by ID.

Request Parameter

Id, the DBID of the persistent agent transport record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2081

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2082

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/deploy

Post /settings/agent/pa-packet-transport-config/deploy

Description

Reinitialize Persistent Agent Transports from the configurations in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/pa-packet-

transport-config/deploy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2083

Fortinet Inc.
Post /settings/agent/pa-packet-transport-config/deploy

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2084

Fortinet Inc.
Delete /settings/agent/pa-packet-transport-config/{id}

Delete /settings/agent/pa-packet-transport-config/{id}

Description

Deletes a single Persistent Agent Transport record by ID.

Request Parameter

Id, the DBID of the persistent agent transport record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/agent/pa-

packet-transport-config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2085

Fortinet Inc.
Delete /settings/agent/pa-packet-transport-config/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2086

Fortinet Inc.
Patch Management

Patch Management

FortiNAC F 7.4.0 REST API 2087

Fortinet Inc.
Get /settings/integration/patch-management

Get /settings/integration/patch-management

Description

Returns all patch management server records.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/integration/patch-

management

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2088

Fortinet Inc.
Get /settings/integration/patch-management

Sample Response

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"results": [
{
"id": 0,
"name": "string",
"type": "string",
"ip": "string",
"status": "string",
"pollingInterval": 0,
"img": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2089

Fortinet Inc.
Post /settings/integration/patch-management/big-fix

Post /settings/integration/patch-management/big-fix

Description

Adds a new BigFix Patch Management server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/big-fix

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"type": "string",
"ip": "string",
"status": "string",
"pollingInterval": 0,
"img": "string",
"bigFixName": "string",
"bigFixPort": 0,
"bigFixUser": "string",
"bigFixPassword": "string"
}

FortiNAC F 7.4.0 REST API 2090

Fortinet Inc.
Post /settings/integration/patch-management/big-fix

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2091

Fortinet Inc.
Post /settings/integration/patch-management/patch-link/{id}

Post /settings/integration/patch-management/patch-link/{id}

Description

Adds a new PatchLink Patch Management server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/properties/patch-link/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"type": "string",
"ip": "string",
"status": "string",
"pollingInterval": 0,
"img": "string"
}

FortiNAC F 7.4.0 REST API 2092

Fortinet Inc.
Post /settings/integration/patch-management/patch-link/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2093

Fortinet Inc.
Post /settings/integration/patch-management/properties/big-fix/{id}

Post /settings/integration/patch-
management/properties/big-fix/{id}

Description

Set BigFix server properties.

Request Parameter

Id, the id of the patch management server record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body parameter

Name Required Type

bigFixPort Optional Integer

bigFixUser Optional String

bigFixName Optional String

bigFixPassword Optional String

pollingInterval Optional String

Sample Request

FortiNAC F 7.4.0 REST API 2094

Fortinet Inc.
Post /settings/integration/patch-management/properties/big-fix/{id}

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/properties/big-fix/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body bigFixPort: "xxxxxxxx"

bigFixUser: "xxxxxxxx"
bigFixName: "xxxxxxxx"
bigFixPassword: "xxxxxxxx"
pollingInterval: "xxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2095

Fortinet Inc.
Post /settings/integration/patch-management/properties/patch-link/{id}

Post /settings/integration/patch-
management/properties/patch-link/{id}

Description

Set PatchLink server properties.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

pollingInterval Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/properties/patch-link/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body pollingInterval: "xxxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2096

Fortinet Inc.
Post /settings/integration/patch-management/properties/patch-link/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2097

Fortinet Inc.
Post /settings/integration/patch-management/test

Post /settings/integration/patch-management/test

Description

Test BigFix Server connection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"type": "string",
"ip": "string",
"status": "string",
"pollingInterval": 0,
"img": "string",
"bigFixName": "string",
"bigFixPort": 0,
"bigFixUser": "string",
"bigFixPassword": "string"
}

FortiNAC F 7.4.0 REST API 2098

Fortinet Inc.
Post /settings/integration/patch-management/test

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2099

Fortinet Inc.
Post /settings/integration/patch-management/test/{id}

Post /settings/integration/patch-management/test/{id}

Description

Test BigFix Server connection.

Request Parameter

Id, the id of the patch management server record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/patch-

management/test/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2100

Fortinet Inc.
Post /settings/integration/patch-management/test/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2101

Fortinet Inc.
Port

Port

FortiNAC F 7.4.0 REST API 2102

Fortinet Inc.
Get /device/port

Get /device/port

Description

Returns a list of Port Records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2103

Fortinet Inc.
Get /device/port

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2104

Fortinet Inc.
Get /device/port/by-device

Get /device/port/by-device

Description

Returns a summary of all ports associated with the supplied network devices.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

devID Required Array[Integer]

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/by-device

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body devID: 2

FortiNAC F 7.4.0 REST API 2105

Fortinet Inc.
Get /device/port/by-device

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": [
{
"id": 0,
"name": "string",
"img": "string"
}
],
"additionalProp2": [
{
"id": 0,
"name": "string",
"img": "string"
}
],
"additionalProp3": [
{
"id": 0,
"name": "string",
"img": "string"
}
]
}
}

FortiNAC F 7.4.0 REST API 2106

Fortinet Inc.
Get /device/port/count

Get /device/port/count

Description

Returns the count of Port records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2107

Fortinet Inc.
Get /device/port/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2108

Fortinet Inc.
Get /device/port/count/all

Get /device/port/count/all

Description

Returns the count of all Port records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2109

Fortinet Inc.
Get /device/port/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2110

Fortinet Inc.
Get /device/port/enforcement

Get /device/port/enforcement

Description

Lists the enforcement status of all ports which match the supplied set of filters.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

state Optional String

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/enforcement

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2111

Fortinet Inc.
Get /device/port/enforcement

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2112

Fortinet Inc.
Get /device/port/enforcement

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2113

Fortinet Inc.
Get /device/port/enforcement/count

Get /device/port/enforcement/count

Description

Lists the total number ports by enforcement status among those that match the supplied filters.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/enforcement/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2114

Fortinet Inc.
Get /device/port/enforcement/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"authentication": 0,
"registration": 0,
"remediation": 0,
"deadEnd": 0,
"roleBasedAccess": 0,
"unenforced": 0
}

FortiNAC F 7.4.0 REST API 2115

Fortinet Inc.
Get /device/port/feature/port-management

Get /device/port/feature/port-management

Description

When modifying multiple ports at once, lists the number of devices that do and do not allow port management settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

devID Required Array[Integer]

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/feature/port-

management

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body devID: 2

FortiNAC F 7.4.0 REST API 2116

Fortinet Inc.
Get /device/port/feature/port-management

Sample Response

{
"status": "string",
"errorMessage": "string",
"portManagementSupported": 0,
"portManagementUnsupported": 0
}

FortiNAC F 7.4.0 REST API 2117

Fortinet Inc.
Get /device/port/{id}

Get /device/port/{id}

Description

Returns the Port record that matches the provided id.

Request Parameter

Id, the Id of the Port Record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2118

Fortinet Inc.
Get /device/port/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2119

Fortinet Inc.
Get /device/port/monitor/{id}

Get /device/port/monitor/{id}

Description

Gets all changes to Port records since they were last polled.

Request Parameter

Id, the Id of the Port record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port/monitor/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2120

Fortinet Inc.
Get /device/port/monitor/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2121

Fortinet Inc.
Get /device/port/monitor/{id}

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2024-01-02T19:25:19.274Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-02T19:25:19.274Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"updated": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
FortiNAC F 7.4.0 REST API
"displayName": "string", 2122
Fortinet Inc. "deviceName": "string",
"deviceID": 0,
"status": 0,
Get /device/port-changes

Get /device/port-changes

Description

Returns all Port Change records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port-changes

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2123

Fortinet Inc.
Get /device/port-changes

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"time": "2023-12-28T23:41:08.380Z",
"state": "string",
"status": "string",
"vlan": "string",
"cli": "string",
"roleName": "string",
"version": 0,
"cliname": "string",
"portId": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2124

Fortinet Inc.
Get /device/port-changes/count

Get /device/port-changes/count

Description

Returns a count of Port Change records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port-changes/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2125

Fortinet Inc.
Get /device/port-changes/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"time": "2023-12-28T23:41:08.380Z",
"state": "string",
"status": "string",
"vlan": "string",
"cli": "string",
"roleName": "string",
"version": 0,
"cliname": "string",
"portId": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2126

Fortinet Inc.
Get /device/port-changes/count/all

Get /device/port-changes/count/all

Description

Returns the count of Port Change records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port-changes/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2127

Fortinet Inc.
Get /device/port-changes/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"time": "2023-12-28T23:41:08.380Z",
"state": "string",
"status": "string",
"vlan": "string",
"cli": "string",
"roleName": "string",
"version": 0,
"cliname": "string",
"portId": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2128

Fortinet Inc.
Get /device/port-changes/{id}

Get /device/port-changes/{id}

Description

Returns the Port Change record with the supplied DBID.

Request Parameter

Id, the DBID of the port change record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/device/port-changes/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2129

Fortinet Inc.
Get /device/port-changes/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"time": "2023-12-28T23:41:08.380Z",
"state": "string",
"status": "string",
"vlan": "string",
"cli": "string",
"roleName": "string",
"version": 0,
"cliname": "string",
"portId": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2130

Fortinet Inc.
Post /device/port/monitor/{id}/stop

Post /device/port/monitor/{id}/stop

Description

Stops collecting changes made of Port records matching the supplied filter.

Request Parameter

Id, the Id of the Port record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/port/monitor/2/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2131

Fortinet Inc.
Post /device/port/monitor/{id}/stop

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 2132

Fortinet Inc.
Post /device/port/monitor/start

Post /device/port/monitor/start

Description

Begins collecting changes made of Port records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/port/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2133

Fortinet Inc.
Post /device/port/monitor/start

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"legacyDBID": 0,
"portType": 0,
"name": "string",
"portID": "string",
"displayName": "string",
"deviceName": "string",
"deviceID": 0,
"status": 0,
"domainID": 0,
"ip": "string",
"physAddr": "string",
"label": "string",
"connectionState": 0,
"defaultVlan": "string",
"currentVlan": "string",
"currentCli": "string",
"notes": "string",
"lastModifiedBy": "string",
"lastChangeSummary": "string",
"lastModifiedDate": "2023-12-29T00:06:25.713Z",
"displayable": true,
"ifname": "string",
"ifindex": "string",
"ifspeed": "string",
"ifdescr": "string",
"ifadminStatus": 0,
"ifoperStatus": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-12-29T00:06:25.713Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"uplinkDisabled": true
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2134

Fortinet Inc.
Post /device/port/properties

Post /device/port/properties

Description

Sets administration properties for the port or ports.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/device/port/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"ids": [
0
],
"name": "string",
"adminStatus": true,
"defaultVlan": "string",
"currentVlan": "string",
"newUplink": 0,
"clearUplink": true,
"note": "string"
}

FortiNAC F 7.4.0 REST API 2135

Fortinet Inc.
Post /device/port/properties

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 2136

Fortinet Inc.
Portal Configuration

Portal Configuration

FortiNAC F 7.4.0 REST API 2137

Fortinet Inc.
Get /policy/portal-configuration

Get /policy/portal-configuration

Description

Returns a list of Port Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2138

Fortinet Inc.
Get /policy/portal-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Portal",
"note": "Created by the Portal Manager - Do NOT
Modify",
"portalElement": 24,
"overrideLastChangeSummary": false,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-
25T17:40:52.000+0000",
"id": 1
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 2139

Fortinet Inc.
Get /policy/portal-configuration/{id}

Get /policy/portal-configuration/{id}

Description

Returns a list of Port Configuration records matching the supplied filter.

Request Parameter

Id, the Id of the Portal Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal-

configuration/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2140

Fortinet Inc.
Get /policy/portal-configuration/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2141

Fortinet Inc.
Get /policy/portal-configuration/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-02T19:46:28.773Z",
"name": "string",
"note": "string",
"portalElement": {
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2024-01-02T19:46:28.773Z",
"lastSuccessfulPoll": "2024-01-
02T19:46:28.773Z",
"mibs": [
"string"
],
"sysOid": "string",
"attribute": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"attributeNames": [
"string"
],
"identification": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
FortiNAC F 7.4.0
}, REST API 2142
Fortinet Inc. "addAuditSummary": "string",
"requestString": "string",
"domainName": "string",
Get /policy/portal-configuration/{id}/usage

Get /policy/portal-configuration/{id}/usage

Description

Returns a list of records that reference this Portal Configuration record.

Request Parameter

Id, the Id of the Portal Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal-

configuration/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2143

Fortinet Inc.
Get /policy/portal-configuration/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2144

Fortinet Inc.
Portal Policy

Portal Policy

FortiNAC F 7.4.0 REST API 2145

Fortinet Inc.
Get /policy/portal

Get /policy/portal

Description

Returns a list of portal policy records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2146

Fortinet Inc.
Get /policy/portal

Sample Response

FortiNAC F 7.4.0 REST API 2147

Fortinet Inc.
Get /policy/portal

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-02T22:34:57.753Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-
02T22:34:57.753Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-
02T22:34:57.753Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
FortiNAC F 7.4.0 REST API
"additionalProp1": "string", 2148
Fortinet Inc. "additionalProp2": "string",
"additionalProp3": "string"
}
Get /policy/portal/supporting-info

Get /policy/portal/supporting-info

Description

Returns the information used to create portal policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2149

Fortinet Inc.
Get /policy/portal/supporting-info

Sample Response

{
"status": "success",
"errorMessage": null,
"portalConfigs": [
{
"name": "Portal",
"id": 1
}
],
"userHostProfiles": [
{
"name": "Global Authentication Conversion",
"id": 1
},
{
"name": "Role Test",
"id": 2
},
{
"name": "Role Test 3",
"id": 3
},
{
"name": "Role Test 2",
"id": 4
}
]
}

FortiNAC F 7.4.0 REST API 2150

Fortinet Inc.
Get /policy/portal/{id}

Get /policy/portal/{id}

Description

Returns a list of portal policy records matching the supplied filter.

Request Parameter

Id, the portal policy record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/portal/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2151

Fortinet Inc.
Get /policy/portal/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2152

Fortinet Inc.
Get /policy/portal/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-02T22:34:57.753Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-
02T22:34:57.753Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-
02T22:34:57.753Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
FortiNAC F 7.4.0 REST API
"additionalProp1": "string", 2153
Fortinet Inc. "additionalProp2": "string",
"additionalProp3": "string"
}
Post /policy/portal

Post /policy/portal

Description

Creates a new portal policy record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-02T23:04:08.245Z",
"name": "string",
"note": "string",
"profile": {
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-02T23:04:08.245Z",
"groupIDs": [
0
],

FortiNAC F 7.4.0 REST API 2154

Fortinet Inc.
Post /policy/portal

"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
},
"configuration": {
"name": "string",
"note": "string",
"portalElement": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 2155

Fortinet Inc.
Post /policy/portal

"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"attributes": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2024-01-02T23:04:08.245Z",
"lastSuccessfulPoll": "2024-01-02T23:04:08.245Z",
"pollable": true,
"security": [
"string"
],
"mibs": [
"string"
],
"sysOid": "string",
"attribute": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"

FortiNAC F 7.4.0 REST API 2156

Fortinet Inc.
Post /policy/portal

}
],
"attributeNames": [
"string"
],
"identification": "string",
"mib": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"requestString": "string",
"domainName": "string",
"securityString": "string",
"packedVersion": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",

FortiNAC F 7.4.0 REST API 2157

Fortinet Inc.
Post /policy/portal

"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"changeMask": 0,
"lastChangeMask": 0
},
"portalID": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-02T23:04:08.245Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
},
"enabled": true,

FortiNAC F 7.4.0 REST API 2158

Fortinet Inc.
Post /policy/portal

"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-02T23:04:08.245Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"configurationName": "string"
}

FortiNAC F 7.4.0 REST API 2159

Fortinet Inc.
Post /policy/portal

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2160

Fortinet Inc.
Post /policy/portal/delete

Post /policy/portal/delete

Description

Deletes a list of portal policy records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:4

FortiNAC F 7.4.0 REST API 2161

Fortinet Inc.
Post /policy/portal/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2162

Fortinet Inc.
Post /policy/portal/disable

Post /policy/portal/disable

Description

Disables the supplied Portal Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2163

Fortinet Inc.
Post /policy/portal/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2164

Fortinet Inc.
Post /policy/portal/enable

Post /policy/portal/enable

Description

Enables a list of portal policy records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2165

Fortinet Inc.
Post /policy/portal/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2166

Fortinet Inc.
 Post /policy/portal/{id}

Post /policy/portal/{id}

Description

Updates an portal policy record.

Request Parameter

Id of the portal policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-02T23:04:08.245Z",
"name": "string",
"note": "string",
"profile": {
"dbid": 0,
"name": "string",

FortiNAC F 7.4.0 REST API 2167

Fortinet Inc.
Post /policy/portal/{id}

"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-02T23:04:08.245Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
},
"configuration": {

FortiNAC F 7.4.0 REST API 2168

Fortinet Inc.
Post /policy/portal/{id}

"name": "string",
"note": "string",
"portalElement": {
"landscape": 0,
"id": 0,
"state": "string",
"elementClass": "string",
"role": "string",
"name": "string",
"type": "string",
"protocol": "string",
"status": "string",
"parent": "string",
"suffix": "string",
"version": 0,
"notes": "string",
"attributes": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",
"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"description": {},
"group": "string",
"pollingInterval": 0,
"lastPoll": "2024-01-02T23:04:08.245Z",
"lastSuccessfulPoll": "2024-01-02T23:04:08.245Z",
"pollable": true,
"security": [
"string"
],
"mibs": [
"string"
],
"sysOid": "string",
"attribute": [
{
"version": 0,
"attributeName": "string",
"attribute": "string",
"table": true,
"discoverObject": true,
"mandatory": true,
"value": "string",

FortiNAC F 7.4.0 REST API 2169

Fortinet Inc.
Post /policy/portal/{id}

"group": "string",
"type": "string",
"access": "string",
"error": "string",
"objectValue": {},
"attributeSuffix": "string"
}
],
"attributeNames": [
"string"
],
"identification": "string",
"mib": "string",
"physicalAddress": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"requestString": "string",
"domainName": "string",
"securityString": "string",
"packedVersion": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",

FortiNAC F 7.4.0 REST API 2170

Fortinet Inc.
Post /policy/portal/{id}

"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-02T23:04:08.245Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"changeMask": 0,
"lastChangeMask": 0
},
"portalID": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-02T23:04:08.245Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",

FortiNAC F 7.4.0 REST API 2171

Fortinet Inc.
Post /policy/portal/{id}

"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
},
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-02T23:04:08.245Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"configurationName": "string"
}

FortiNAC F 7.4.0 REST API 2172

Fortinet Inc.
Post /policy/portal/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2173

Fortinet Inc.
Post /policy/portal/{id}/delete

Post /policy/portal/{id}/delete

Description

Deletes a single portal policy record by ID.

Request Parameter

Id, the Id of the portal policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/2/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2174

Fortinet Inc.
Post /policy/portal/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2175

Fortinet Inc.
Post /policy/portal/rank/set

Post /policy/portal/rank/set

Description

Sets the rank of the supplied portal policy, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

rank Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2176

Fortinet Inc.
Post /policy/portal/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2177

Fortinet Inc.
Post /policy/portal/rank/swap

Post /policy/portal/rank/swap

Description

Swaps the rank position of the two supplied portal policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Required Integer

id2 Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/portal/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2178

Fortinet Inc.
Post /policy/portal/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2179

Fortinet Inc.
Delete /policy/portal-configuration/{id}

Delete /policy/portal-configuration/{id}

Description

Deletes a single portal policy record by ID.

Request Parameter

Id, the portal policy record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/portal/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2180

Fortinet Inc.
Delete /policy/portal-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2181

Fortinet Inc.
Portal Settings

Portal Settings

FortiNAC F 7.4.0 REST API 2182

Fortinet Inc.
Get /portal/settings/ssl

Get /portal/settings/ssl

Description

Returns the currently configured portal SSL settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/portal/settings/ssl

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2183

Fortinet Inc.
Get /portal/settings/ssl

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"fqHostname": "pd-test",
"sslMode": "NO_SSL",
"enableShibboleth": false,
"useNetworkAssistant": false,
"showShibboleth": false
}
}

FortiNAC F 7.4.0 REST API 2184

Fortinet Inc.
Post /portal/settings/ssl

Post /portal/settings/ssl

Description

Modifies portal SSL settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/portal/settings/ssl

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"fqHostname": "string",
"sslMode": "string",
"enableShibboleth": true,
"useNetworkAssistant": true
}

FortiNAC F 7.4.0 REST API 2185

Fortinet Inc.
Post /portal/settings/ssl

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2186

Fortinet Inc.
Quarantine

Quarantine

FortiNAC F 7.4.0 REST API 2187

Fortinet Inc.
Get /settings/device/quarantine

Get /settings/device/quarantine

Description

Returns the currently configured Quarantine Properties

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/quarantine

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2188

Fortinet Inc.
Get /settings/device/quarantine

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"quarantineVlanSwitching": "
{\"startIP\":\"92.45.36.200\",\"endIP\":\"92.45.36.220\"}"
}
}

FortiNAC F 7.4.0 REST API 2189

Fortinet Inc.
Post /settings/device/quarantine

Post /settings/device/quarantine

Description

Sets the Quarantine properties.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

quarantineVlanSwitching Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/quarantine

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body quarantineVlanSwitching: "xxxxxxxxxxxxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2190

Fortinet Inc.
Post /settings/device/quarantine

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2191

Fortinet Inc.
Post /settings/device/quarantine/mark-all-hosts-safe

Post /settings/device/quarantine/mark-all-hosts-safe

Description

Sets all the hosts from Risk State to Safe.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/quarantine/mark-all-

hosts-safe

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2192

Fortinet Inc.
Post /settings/device/quarantine/mark-all-hosts-safe

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2193

Fortinet Inc.
Radius Attribute Group Configuration

Radius Attribute Group Configuration

FortiNAC F 7.4.0 REST API 2194

Fortinet Inc.
Get /radius/attrgroups

Get /radius/attrgroups

Description

Get all defined RADIUS attribute groups, or if provided those matching specified filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/attrgroups

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2195

Fortinet Inc.
Get /radius/attrgroups

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 4,
"name": "Aruba_Role",
"attributes": [
{
"dbid": 4917,
"type": "string",
"attribute": "Aruba-User-Role",
"value": "1",
"vendor": "Aruba",
"vendorId": 14813,
"hasTag": false,
"custom": false,
"definedValues": {},
"responseValues": [
"%ACCESS_VALUE%"
]
}
],
"usage": "{\"name\":\"Aruba_Role\",\"inuse\":false,\"deviceList\":
[],\"srcList\":[],\"ssidList\":[],\"vdomList\":[]}"
}
]
}

FortiNAC F 7.4.0 REST API 2196

Fortinet Inc.
Get /radius/attrgroups/modelcfg/{deviceId}

Get /radius/attrgroups/modelcfg/{deviceId}

Description

Get the RADIUS attribute group ID for the specified device ID, or if specified it's logical network.

Request Parameter

deviceId, the device ID of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

logicalNetwork optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/attrgroups/modelcfg/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2197

Fortinet Inc.
Get /radius/attrgroups/modelcfg/{deviceId}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2198

Fortinet Inc.
Get /radius/attrgroups/{attrGroupId}

Get /radius/attrgroups/{attrGroupId}

Description

Get RADIUS attribute group with specified ID.

Request Parameter

attrGroupId, the ID of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/attrgroups/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2199

Fortinet Inc.
Get /radius/attrgroups/{attrGroupId}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 4,
"name": "Aruba_Role",
"attributes": [
{
"dbid": 4917,
"type": "string",
"attribute": "Aruba-User-Role",
"value": "1",
"vendor": "Aruba",
"vendorId": 14813,
"hasTag": false,
"custom": false,
"definedValues": {},
"responseValues": [
"%ACCESS_VALUE%"
]
}
],
"usage": "{\"name\":\"Aruba_Role\",\"inuse\":false,\"deviceList\":
[],\"srcList\":[],\"ssidList\":[],\"vdomList\":[]}"
}
]
}

FortiNAC F 7.4.0 REST API 2200

Fortinet Inc.
Get /radius/attrgroups/name/{groupName}

Get /radius/attrgroups/name/{groupName}

Description

Get RADIUS attribute group by name.

Request Parameter

groupName, the group name of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/attrgroups/name/Aruba_Vlan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2201

Fortinet Inc.
Get /radius/attrgroups/name/{groupName}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 4,
"name": "Aruba_Role",
"attributes": [
{
"dbid": 4917,
"type": "string",
"attribute": "Aruba-User-Role",
"value": "1",
"vendor": "Aruba",
"vendorId": 14813,
"hasTag": false,
"custom": false,
"definedValues": {},
"responseValues": [
"%ACCESS_VALUE%"
]
}
],
"usage": "{\"name\":\"Aruba_Role\",\"inuse\":false,\"deviceList\":
[],\"srcList\":[],\"ssidList\":[],\"vdomList\":[]}"
}
]
}

FortiNAC F 7.4.0 REST API 2202

Fortinet Inc.
Get /radius/attrgroups/{attrGroupId}/usage

Get /radius/attrgroups/{attrGroupId}/usage

Description

Get the usage data for the specified attribute group.

Request Parameter

attrGroupId, the ID of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/attrgroups/4/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2203

Fortinet Inc.
Get /radius/attrgroups/{attrGroupId}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "{\"name\":\"Aruba_Role\",\"inuse\":false,\"deviceList\":
[],\"srcList\":[],\"ssidList\":[],\"vdomList\":[]}"
}

FortiNAC F 7.4.0 REST API 2204

Fortinet Inc.
Get /radius/attrgroups/list

Get /radius/attrgroups/list

Description

Get list of RADIUS attribute groups, returns name and id of each.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/attrgroups/list

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2205

Fortinet Inc.
Get /radius/attrgroups/list

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"name": "Aruba_Role",
"id": 4
},
{
"name": "Aruba_Vlan",
"id": 3
},
{
"name": "CiscoVPN",
"id": 5
},
{
"name": "RFC_Role",
"id": 2
},
{
"name": "RFC_Vlan",
"id": 1
}
]
}

FortiNAC F 7.4.0 REST API 2206

Fortinet Inc.
Get /radius/attrgroups/responsevalues/{deviceAttrGrpId}/{logicalNetworkAttrGrpId}

Get /radius/attrgroups/responsevalues/{deviceAttrGrpId}/
{logicalNetworkAttrGrpId}

Description

Get the response values for the device attribute group ID and logical network attribute group ID.

Request Parameters

Name Required Type

deviceAttrGrpId required Integer

logicalNetworkAttrGrpId required Integer

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request POST https://10.106.94.152:8443/api/v2/radius/attrgroups/responsevalues/3/3

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2207

Fortinet Inc.
Get /radius/attrgroups/responsevalues/{deviceAttrGrpId}/{logicalNetworkAttrGrpId}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "{\"logicalNetworkAttrs\":[{\"Aruba-User-Vlan\":\"[%ACCESS_
VALUE%]\"}],\"deviceDefaultAttrs\":[{\"Aruba-User-Vlan\":\"
[%ACCESS_VALUE%]\"}],\"deviceDefaultAttrGroupName\":\"Aruba_
Vlan\",\"logicalNetworkAttrGroupName\":\"Aruba_Vlan\"}"
}

FortiNAC F 7.4.0 REST API 2208

Fortinet Inc.
Post /radius/attrgroups

Post /radius/attrgroups

Description

Create new RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/attrgroups

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"attributes": [
{
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",
"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,
"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",

FortiNAC F 7.4.0 REST API 2209

Fortinet Inc.
Post /radius/attrgroups

"additionalProp2": "string",
"additionalProp3": "string"
},
"responseValues": [
"string"
]
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-03T19:52:27.746Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

FortiNAC F 7.4.0 REST API 2210

Fortinet Inc.
Post /radius/attrgroups

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"dbid": 0,
"name": "string",
"attributes": [
{
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",
"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,
"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"responseValues": [
"string"
]
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-03T22:43:22.777Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
}

FortiNAC F 7.4.0 REST API 2211

Fortinet Inc.
Post /radius/attrgroups/delete

Post /radius/attrgroups/delete

Description

Delete multiple RADIUS attribute groups by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

Id optional Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/attrgroups/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body Id:6

FortiNAC F 7.4.0 REST API 2212

Fortinet Inc.
Post /radius/attrgroups/delete

Sample Response

{
"status": "success",
"errorMessage": null,
"results": true
}

FortiNAC F 7.4.0 REST API 2213

Fortinet Inc.
Post /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId}

Post /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId}

Description

Assign the RADIUS attribute group ID to the specified device ID, or if specified it's logical network.

Request Parameter

deviceId, the DBID of the RADIUS attribute group.

attrGroupId, the RADIUS attribute group ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

logicalNetwork optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/attrgroups/modelcfg/4/3

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2214

Fortinet Inc.
Post /radius/attrgroups/modelcfg/{deviceId}/{attrGroupId}

Content-Type: application/json

Sample Response

{
"status": "success",
"errorMessage": null,
"results": true
}

FortiNAC F 7.4.0 REST API 2215

Fortinet Inc.
Post /radius/attrgroups/{id}

Post /radius/attrgroups/{id}

Description

Update RADIUS attribute group by ID.

Request Parameter

Id, the RADIUS attribute group Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/attrgroups/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"attributes": [
{
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",

FortiNAC F 7.4.0 REST API 2216

Fortinet Inc.
Post /radius/attrgroups/{id}

"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,
"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"responseValues": [
"string"
]
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-03T19:52:27.746Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

FortiNAC F 7.4.0 REST API 2217

Fortinet Inc.
Post /radius/attrgroups/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"dbid": 0,
"name": "string",
"attributes": [
{
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",
"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,
"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"responseValues": [
"string"
]
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-03T22:43:22.777Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
}

FortiNAC F 7.4.0 REST API 2218

Fortinet Inc.
Delete /radius/attrgroups/{id}

Delete /radius/attrgroups/{id}

Description

Delete RADIUS attribute group by ID.

Request Parameter

Id, the DBID of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/radius/attrgroups/4

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2219

Fortinet Inc.
Delete /radius/attrgroups/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": null
}

FortiNAC F 7.4.0 REST API 2220

Fortinet Inc.
Delete /radius/attrgroups/modelcfg/{deviceId}

Delete /radius/attrgroups/modelcfg/{deviceId}

Description

Delete the RADIUS attribute group ID(if one exists) for the model configuration ID, or if specified it's logical network.

Request Parameter

deviceId, the DBID of the RADIUS attribute group.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

logicalNetwork optional String

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/radius/attrgroups/modelcfg/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2221

Fortinet Inc.
Delete /radius/attrgroups/modelcfg/{deviceId}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": true
}

FortiNAC F 7.4.0 REST API 2222

Fortinet Inc.
Radius Dictionary Configuration

Radius Dictionary Configuration

FortiNAC F 7.4.0 REST API 2223

Fortinet Inc.
Get /radius/dictionary

Get /radius/dictionary

Description

Get the RADIUS dictionary entries. (If filter is specified, matching attribute, vendor, vendorId, isCustom)

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/dictionary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2224

Fortinet Inc.
Get /radius/dictionary

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"dbid": 6302,
"type": "integer",
"attribute": "Acct-Authentic",
"value": "42",
"hasTag": false,
"custom": false,
"definedValues": {
"1": "RADIUS",
"2": "Local",
"3": "Remote",
"4": "Diameter"
}
}
}

FortiNAC F 7.4.0 REST API 2225

Fortinet Inc.
Get /radius/dictionary/attribute/{name}

Get /radius/dictionary/attribute/{name}

Description

Get the RADIUS dictinoary entry of the specified name.

Request Parameter

Name Required Type

name Required String

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/dictionary/attribute/Acct-

Authentic

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2226

Fortinet Inc.
Get /radius/dictionary/attribute/{name}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"dbid": 6302,
"type": "integer",
"attribute": "Acct-Authentic",
"value": "42",
"hasTag": false,
"custom": false,
"definedValues": {
"1": "RADIUS",
"2": "Local",
"3": "Remote",
"4": "Diameter"
}
}
}

FortiNAC F 7.4.0 REST API 2227

Fortinet Inc.
Post /radius/dictionary

Post /radius/dictionary

Description

Create user-defined RADIUS dictionary entry.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/dictionary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",
"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,
"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2228

Fortinet Inc.
Post /radius/dictionary

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"dbid": 6302,
"type": "integer",
"attribute": "Acct-Authentic",
"value": "42",
"hasTag": false,
"custom": false,
"definedValues": {
"1": "RADIUS",
"2": "Local",
"3": "Remote",
"4": "Diameter"
}
}
}

FortiNAC F 7.4.0 REST API 2229

Fortinet Inc.
Post /radius/dictionary/delete

Post /radius/dictionary/delete

Description

Delete multiple user-defined RADIUS dictionary entries by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/radius/dictionary/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 6309

FortiNAC F 7.4.0 REST API 2230

Fortinet Inc.
Post /radius/dictionary/delete

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2231

Fortinet Inc.
Post /radius/dictionary/{id}

Post /radius/dictionary/{id}

Description

Update user-defined RADIUS dictionary entry by ID.

Request Parameter

Id, the Id of the RADIUS dictionary entry.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/dictionary/6302

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"type": "string",
"attribute": "string",
"value": "string",
"format": "string",
"vendor": "string",
"vendorId": 0,
"hasTag": true,

FortiNAC F 7.4.0 REST API 2232

Fortinet Inc.
Post /radius/dictionary/{id}

"encryptMethod": 0,
"custom": true,
"definedValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"dbid": 6302,
"type": "integer",
"attribute": "Acct-Authentic",
"value": "42",
"hasTag": false,
"custom": false,
"definedValues": {
"1": "RADIUS",
"2": "Local",
"3": "Remote",
"4": "Diameter"
}
}
}

FortiNAC F 7.4.0 REST API 2233

Fortinet Inc.
Delete /radius/dictionary/{id}

Delete /radius/dictionary/{id}

Description

Delete the user-defined RADIUS dictionary entry by ID.

Request Parameter

Id, the Id of the RADIUS dictionary entry.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/radius/dictionary/6309

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2234

Fortinet Inc.
Delete /radius/dictionary/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2235

Fortinet Inc.
Radius Health

Radius Health

FortiNAC F 7.4.0 REST API 2236

Fortinet Inc.
Get /radius/radius-health

Get /radius/radius-health

Description

Return all RADIUS health snapshots.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/radius-health

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2237

Fortinet Inc.
Get /radius/radius-health

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"groupId": 0,
"reply": "string",
"count": 0,
"message": "string",
"duration": 0,
"date": "2024-05-09T23:28:23.748Z",
"auditObj": {
"user": "string",
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-05-09T23:28:23.748Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string"
}
],
"filtered": 0,
"total": 0,
"totals": {
"reply": [
{
"name": "string",
"count": 0
}
],
"message": [
{
"name": "string",
"count": 0
}
]
}
}

FortiNAC F 7.4.0 REST API 2238

Fortinet Inc.
Get /radius/radius-health-details

Get /radius/radius-health-details

Description

Return all RADIUS response records.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-health-

details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2239

Fortinet Inc.
Get /radius/radius-health-details

Sample Response

FortiNAC F 7.4.0 REST API 2240

Fortinet Inc.
Get /radius/radius-health-details

{
"status": "string",
"errorMessage": "string",
"results": [
{
"callingStationId": "string",
"username": "string",
"reply": "string",
"message": "string",
"date": "2024-05-08T22:39:34.974Z",
"nas": "string",
"outerEapType": "string",
"eapType": "string",
"clusterNode": "string",
"auditObj": {
"user": "string",
"auditDBID": 0,
"liveDBID": 0,
"liveObj": {
"auditObj": "string",
"yamsEventTag": "string"
},
"action": "string",
"timestamp": "2024-05-08T22:39:34.974Z",
"auditObj": "string",
"yamsEventTag": "string"
},
"yamsEventTag": "string",
"id": 0
}
],
"filtered": 0,
"total": 0,
"totals": {
"callingStationId": [
{
"name": "string",
"count": 0
}
],
"username": [
{
"name": "string",
"count": 0
}
],
"nas": [
{
"name": "string",
"count": 0
}
],
"message": [
{
"name": "string",
"count": 0
}
]
}
}
FortiNAC F 7.4.0 REST API 2241
Fortinet Inc.
Get /radius/radius-health/timeline

Get /radius/radius-health/timeline

Description

Returns set of RADIUS health snapshots showing RADIUS activity over time.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

timespan Optional Integer

timespanUnit Optional Integer

datapointTimespan Optional Integer

datapointTimespanUnit Optional Integer

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-

health/timeline

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2242

Fortinet Inc.
Get /radius/radius-health/timeline

Request Body timespan: 24

timespanUnit: 2
datapointTimespan: 60
datapointTimespanUnit: 1
(All with default values)

FortiNAC F 7.4.0 REST API 2243

Fortinet Inc.
Get /radius/radius-health/timeline

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"acceptCount": 0,
"rejectCount": 0,
"totalCount": 0,
"failureRate": 0,
"rejectCountByCause": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"duration": 0,
"date": "2024-01-25T18:40:07.300Z",
"historicalStats": [
{
"offset": 0,
"offsetTypeStr": "string",
"offsetType": 0,
"failureRate": 0,
"failureRateDelta": 0,
"failureRateIncrease": true,
"failureRateWarning": true,
"acceptCount": 0,
"acceptDelta": 0,
"acceptDecrease": true,
"acceptWarning": true,
"rejectCount": 0,
"rejectDelta": 0,
"rejectIncrease": true,
"rejectWarning": true,
"totalCount": 0,
"totalDelta": 0,
"totalDecrease": true,
"totalWarning": true,
"averaged": true,
"averageSampleSize": 0,
"warningThreshold": 0,
"failureRateWarningThreshold": 0
}
]
}
]
}

FortiNAC F 7.4.0 REST API 2244

Fortinet Inc.
Get /radius/radius-health/latest

Get /radius/radius-health/latest

Description

Returns set of RADIUS health snapshots showing latest RADIUS activity over time.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

timespan Optional Integer

timespanUnit Optional Integer

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-

health/latest

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body timespan: 60

timespanUnit: 1
(All with default values)

FortiNAC F 7.4.0 REST API 2245

Fortinet Inc.
Get /radius/radius-health/latest

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"acceptCount": 0,
"rejectCount": 0,
"totalCount": 0,
"failureRate": 0,
"rejectCountByCause": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"duration": 0,
"date": "2024-01-25T18:40:07.300Z",
"historicalStats": [
{
"offset": 0,
"offsetTypeStr": "string",
"offsetType": 0,
"failureRate": 0,
"failureRateDelta": 0,
"failureRateIncrease": true,
"failureRateWarning": true,
"acceptCount": 0,
"acceptDelta": 0,
"acceptDecrease": true,
"acceptWarning": true,
"rejectCount": 0,
"rejectDelta": 0,
"rejectIncrease": true,
"rejectWarning": true,
"totalCount": 0,
"totalDelta": 0,
"totalDecrease": true,
"totalWarning": true,
"averaged": true,
"averageSampleSize": 0,
"warningThreshold": 0,
"failureRateWarningThreshold": 0
}
]
}
]
}

FortiNAC F 7.4.0 REST API 2246

Fortinet Inc.
Get /radius/radius-health/snapshot-interval

Get /radius/radius-health/snapshot-interval

Description

Returns interval at which RADIUS health snapshots are taken.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-

health/snapshot-interval

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2247

Fortinet Inc.
Get /radius/radius-health/snapshot-interval

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": 5
}

FortiNAC F 7.4.0 REST API 2248

Fortinet Inc.
Radius Server Configuration

Radius Server Configuration

FortiNAC F 7.4.0 REST API 2249

Fortinet Inc.
Get /radius/radius-server-config/activityStatus

Get /radius/radius-server-config/activityStatus

Description

Returns true if RADIUS Activity Monitoring is enabled.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/radius-server-

config/activityStatus

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2250

Fortinet Inc.
Get /radius/radius-server-config/activityStatus

Sample Response

{
"status": "success",
"errorMessage": null,
"results": true
}

FortiNAC F 7.4.0 REST API 2251

Fortinet Inc.
Get /radius/radius-server-config/eap-types

Get /radius/radius-server-config/eap-types

Description

Returns the list of EAP types that are supported by the Local RADIUS server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/radius-server-

config/eap-types

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2252

Fortinet Inc.
Get /radius/radius-server-config/eap-types

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
"TLS",
"TTLS",
"PEAP",
"MD5",
"GTC",
"MSCHAPV2",
"FAST"
]
}

FortiNAC F 7.4.0 REST API 2253

Fortinet Inc.
Get /radius/radius-server-config/global

Get /radius/radius-server-config/global

Description

Retrieves the global configuration settings for the local RADIUS service.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-server-

config/global

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2254

Fortinet Inc.
Get /radius/radius-server-config/global

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"authPort": 1645,
"radSecAuthPort": 2083,
"proxyAuthPort": 1812,
"radSecEnabled": false,
"radSecRequired": false,
"radSecClientCertRequired": true,
"serviceEnabled": false,
"serviceRunning": false,
"healthMonitoring": false,
"sendFailureEvents": false,
"tlsConfig": {
"id": null,
"lastModifiedBy": null,
"lastModifiedDate": "1970-01-01T00:00:00.000+0000",
"name": "RadSec",
"ciphers": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"tlsProtocols": "TLSv1.2",
"certAlias": "radsec",
"clientAuthMode": "NONE",
"clientAuthAliases": null,
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": null,
"GUID": null
},
"serviceLogLevel": 0,
"serviceDebugHostFilter": null,
"serverDebugEnabled": false,
"serverDebugHostFilter": null,
"serverPolicyDebugEnabled": false
}
}

FortiNAC F 7.4.0 REST API 2255

Fortinet Inc.
Get /radius/radius-server-config/{id}

Get /radius/radius-server-config/{id}

Description

Return RADIUS server configuration object by ID.

Request Parameter

Id, the RADIUS server configuration object ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-server-

config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2256

Fortinet Inc.
Get /radius/radius-server-config/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"name": "DefaultConfig",
"tlsServiceConfiguration": {
"id": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-01-17T01:28:42.000+0000",
"name": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"ciphers": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"tlsProtocols": "TLSv1.2",
"certAlias": "radius",
"clientAuthMode": "OPTIONAL",
"clientAuthAliases": "radius_trust",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2023-08-25T17:40:36.000+0000",
"GUID": null
},
"winbindConfigurations": [],
"tlsEapTlsFragmentSize": 1002,
"tlsCommonFragmentSize": 1200,
"eapFastServerUnauthenticatedProvisioning": false,
"eapFastServerAuthenticatedProvisioning": false,
"tlsConfigID": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:36.000+0000",
"allowAnyWinbindConfig": true,
"ocspEnabled": false,
"enabledEapTypes": [
"TTLS",
"PEAP",
"MD5",
"GTC",
"MSCHAPV2"
],
"winbindConfigStr": "All",
"tlsConfigName": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"tlsCertificateAlias": "radius"
}
]
}

FortiNAC F 7.4.0 REST API 2257

Fortinet Inc.
Get /radius/radius-server-config/generateFastPacKey

Get /radius/radius-server-config/generateFastPacKey

Description

Returns a 32 Byte random string for use with EAP-FAST (pac_opaque_key)

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-server-

config/generateFastPacKey

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2258

Fortinet Inc.
Get /radius/radius-server-config/generateFastPacKey

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "a6dd5ddaef0c985471xxxxxxxxxx"
}

FortiNAC F 7.4.0 REST API 2259

Fortinet Inc.
Get /radius/radius-server-config/status

Get /radius/radius-server-config/status

Description

Returns the current status for the RADIUS service.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/radius-server-

config/status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2260

Fortinet Inc.
Get /radius/radius-server-config/status

Sample Response

{
"status": "string",
"errorMessage": "string",
"processEnabled": true,
"processRunning": true,
"serviceStatus": "string"
}

FortiNAC F 7.4.0 REST API 2261

Fortinet Inc.
Get /radius/radius-server-config

Get /radius/radius-server-config

Description

Return all RADIUS server configuration objects.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/radius/radius-server-

config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2262

Fortinet Inc.
Get /radius/radius-server-config

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"name": "DefaultConfig",
"tlsServiceConfiguration": {
"id": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-01-17T01:28:42.000+0000",
"name": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"ciphers": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"tlsProtocols": "TLSv1.2",
"certAlias": "radius",
"clientAuthMode": "OPTIONAL",
"clientAuthAliases": "radius_trust",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2023-08-25T17:40:36.000+0000",
"GUID": null
},
"winbindConfigurations": [],
"tlsEapTlsFragmentSize": 1002,
"tlsCommonFragmentSize": 1200,
"eapFastServerUnauthenticatedProvisioning": false,
"eapFastServerAuthenticatedProvisioning": false,
"tlsConfigID": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:36.000+0000",
"allowAnyWinbindConfig": true,
"ocspEnabled": false,
"enabledEapTypes": [
"TTLS",
"PEAP",
"MD5",
"GTC",
"MSCHAPV2"
],
"winbindConfigStr": "All",
"tlsConfigName": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"tlsCertificateAlias": "radius"
}
]
}

FortiNAC F 7.4.0 REST API 2263

Fortinet Inc.
Get /radius/radius-server-config/log

Get /radius/radius-server-config/log

Description

Retrieves the RADIUS service log (var/log/radius/radius.log), systemd journal, and output master entries containing

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

lines Required Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/radius/radius-server-

config/log

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body lines: 1000 (default value)

FortiNAC F 7.4.0 REST API 2264

Fortinet Inc.
Get /radius/radius-server-config/log

Sample Response

{
"status": "string",
"errorMessage": "string",
"log": "string",
"systemdJournal": "string",
"serverLog": "string"

FortiNAC F 7.4.0 REST API 2265

Fortinet Inc.
Post /radius/radius-server-config/delete

Post /radius/radius-server-config/delete

Description

Delete multiple RADIUS server configuration object by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 5

FortiNAC F 7.4.0 REST API 2266

Fortinet Inc.
Post /radius/radius-server-config/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2267

Fortinet Inc.
Post /radius/radius-server-config/disable

Post /radius/radius-server-config/disable

Description

Disables the RadiusServer service for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/disble

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2268

Fortinet Inc.
Post /radius/radius-server-config/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2269

Fortinet Inc.
Post /radius/radius-server-config/enable

Post /radius/radius-server-config/enable

Description

Enables the RadiusServer service for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2270

Fortinet Inc.
Post /radius/radius-server-config/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2271

Fortinet Inc.
Post /radius/radius-server-config/{id}

Post /radius/radius-server-config/{id}

Description

Update an existing RADIUS server configuration object.

Request Parameter

Id, the RADIUS server configuration object ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"authPort": 0,
"tlsConfigID": 0,
"allowAnyWinbindConfig": true,
"winbindConfigurations": [
{
"dbid": 0,

FortiNAC F 7.4.0 REST API 2272

Fortinet Inc.
Post /radius/radius-server-config/{id}

"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-25T23:37:12.270Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"enabledEapTypes": [
"string"
],
"ocspEnabled": true,
"tlsEapTlsFragmentSize": 0,
"tlsCommonFragmentSize": 0,
"fastPacKey": "string",
"eapFastServerUnauthenticatedProvisioning": true,
"eapFastServerAuthenticatedProvisioning": true
}

FortiNAC F 7.4.0 REST API 2273

Fortinet Inc.
Post /radius/radius-server-config/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"name": "DefaultConfig",
"tlsServiceConfiguration": {
"id": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-01-17T01:28:42.000+0000",
"name": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"ciphers": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"tlsProtocols": "TLSv1.2",
"certAlias": "radius",
"clientAuthMode": "OPTIONAL",
"clientAuthAliases": "radius_trust",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2023-08-25T17:40:36.000+0000",
"GUID": null
},
"winbindConfigurations": [],
"tlsEapTlsFragmentSize": 1002,
"tlsCommonFragmentSize": 1200,
"eapFastServerUnauthenticatedProvisioning": false,
"eapFastServerAuthenticatedProvisioning": false,
"tlsConfigID": 2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:36.000+0000",
"allowAnyWinbindConfig": true,
"ocspEnabled": false,
"enabledEapTypes": [
"TTLS",
"PEAP",
"MD5",
"GTC",
"MSCHAPV2"
],
"winbindConfigStr": "All",
"tlsConfigName": "RADIUS EAP 9f8fbecb-7b6c-4403-b7f6-aae9595531ff",
"tlsCertificateAlias": "radius"
}
]
}

FortiNAC F 7.4.0 REST API 2274

Fortinet Inc.
Post /radius/radius-server-config/nas/fixstale/{id}

Post /radius/radius-server-config/nas/fixstale/{id}

Description

Updates all NAS that are configured to use a RADIUS server configuration that no longer exists to use the specified cfg
ID.

Request Parameter

Id, the RADIUS server configuration object ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/nas/fixstale/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2275

Fortinet Inc.
Post /radius/radius-server-config/nas/fixstale/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2276

Fortinet Inc.
Post /radius/radius-server-config/nas/fixstale/{id}

{
"status": "string",
"errorMessage": "string",
"result": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"dbid": 0,
"name": "string",
"tlsServiceConfiguration": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-01-25T19:36:46.557Z",
"gUID": 0,
"id": 0
},
"winbindConfigurations": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-25T19:36:46.557Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"tlsEapTlsFragmentSize": 0,
"tlsCommonFragmentSize": 0,
"fastPacKey": "string",
"eapFastServerUnauthenticatedProvisioning": true,
"eapFastServerAuthenticatedProvisioning": true,
FortiNAC F"transientTlsConfigID":
7.4.0 REST API 0, 2277
Fortinet Inc.
"tlsConfigID": 0,
"auditObjectName": "string",
"auditObjectType": {
Post /radius/radius-server-config/global

Post /radius/radius-server-config/global

Description

Set the global Local Radius config that applies to all LocalRadiusConfiguration instances, such as auth port.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config/global

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"authPort": 0,
"proxyAuthPort": 0,
"serviceEnabled": true,
"serviceRunning": true,
"healthMonitoring": true,
"sendFailureEvents": true,
"serviceLogLevel": 0,
"serviceDebugHostFilter": "string",
"serverDebugEnabled": true,
"serverDebugHostFilter": "string",
"serverPolicyDebugEnabled": true
}

FortiNAC F 7.4.0 REST API 2278

Fortinet Inc.
Post /radius/radius-server-config/global

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": []
}

FortiNAC F 7.4.0 REST API 2279

Fortinet Inc.
Post /radius/radius-server-config

Post /radius/radius-server-config

Description

Creates a RADIUS server configuration object.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/radius/radius-server-

config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"tlsServiceConfiguration": {
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-01-25T19:36:46.557Z",
"gUID": 0,
"id": 0
},
"winbindConfigurations": [

FortiNAC F 7.4.0 REST API 2280

Fortinet Inc.
Post /radius/radius-server-config

{
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-25T19:36:46.557Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"tlsEapTlsFragmentSize": 0,
"tlsCommonFragmentSize": 0,
"fastPacKey": "string",
"eapFastServerUnauthenticatedProvisioning": true,
"eapFastServerAuthenticatedProvisioning": true,
"transientTlsConfigID": 0,
"tlsConfigID": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-25T19:36:46.557Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",

FortiNAC F 7.4.0 REST API 2281

Fortinet Inc.
Post /radius/radius-server-config

"auditObj": "string"
},
"allowAnyWinbindConfig": true,
"ocspEnabled": true,
"enabledEapTypes": [
"TLS"
],
"tlsCertificateAlias": "string",
"winbindConfigStr": "string",
"tlsConfigName": "string"
}

FortiNAC F 7.4.0 REST API 2282

Fortinet Inc.
Post /radius/radius-server-config

Sample Response

FortiNAC F 7.4.0 REST API 2283

Fortinet Inc.
Post /radius/radius-server-config

{
"status": "string",
"errorMessage": "string",
"result": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"dbid": 0,
"name": "string",
"tlsServiceConfiguration": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-01-25T19:36:46.557Z",
"gUID": 0,
"id": 0
},
"winbindConfigurations": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-25T19:36:46.557Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-25T19:36:46.557Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"tlsEapTlsFragmentSize": 0,
"tlsCommonFragmentSize": 0,
"fastPacKey": "string",
"eapFastServerUnauthenticatedProvisioning": true,
"eapFastServerAuthenticatedProvisioning": true,
FortiNAC F"transientTlsConfigID":
7.4.0 REST API 0, 2284
Fortinet Inc.
"tlsConfigID": 0,
"auditObjectName": "string",
"auditObjectType": {
Delete /radius/radius-server-config/{id}

Delete /radius/radius-server-config/{id}

Description

Delete RADIUS server configuration object by ID.

Request Parameter

Id, the RADIUS server configuration object ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/radius/radius-server-

config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2285

Fortinet Inc.
Delete /radius/radius-server-config/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2286

Fortinet Inc.
Rogue DHCP Detection

Rogue DHCP Detection

FortiNAC F 7.4.0 REST API 2287

Fortinet Inc.
Get /settings/device/rogue-DHCP-detection

Get /settings/device/rogue-DHCP-detection

Description

Returns the currently configured DHCP settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/rogue-DHCP-

detection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2288

Fortinet Inc.
Get /settings/device/rogue-DHCP-detection

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"dhcpInterface": "eth1"
}
}

FortiNAC F 7.4.0 REST API 2289

Fortinet Inc.
Get /settings/device/rogue-DHCP-detection/vlans

Get /settings/device/rogue-DHCP-detection/vlans

Description

Returns the configured rogue DHCP vlans to scan.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/device/rogue-DHCP-

detection/vlans

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2290

Fortinet Inc.
Get /settings/device/rogue-DHCP-detection/vlans

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"vlanID": 0,
"vlanName": "string",
"dbid": 0
}
]
}

FortiNAC F 7.4.0 REST API 2291

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection

Post /settings/device/rogue-DHCP-detection

Description

Adds a DHCP server Config

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

dhcpInterface Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/rogue-DHCP-

detection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body dhcpInterface: eth2

FortiNAC F 7.4.0 REST API 2292

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2293

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection/vlan

Post /settings/device/rogue-DHCP-detection/vlan

Description

Adds a new vlan to scan for Rogue DHCP detection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

vlan Required Integer

vlanName Required String

dbid Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/rogue-DHCP-

detection/vlan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body vlan: 3

vlanName: eth3

FortiNAC F 7.4.0 REST API 2294

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection/vlan

dbid: 3

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2295

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection/vlan/delete

Post /settings/device/rogue-DHCP-detection/vlan/delete

Description

Deletes one or more vlans being scanned for Rogue DHCP servers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

dbid Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/device/rogue-DHCP-

detection/vlan/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body dbid: 3

FortiNAC F 7.4.0 REST API 2296

Fortinet Inc.
Post /settings/device/rogue-DHCP-detection/vlan/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2297

Fortinet Inc.
Role

Role

FortiNAC F 7.4.0 REST API 2298

Fortinet Inc.
Get /policy/role-mapping/{id}/usage

Get /policy/role-mapping/{id}/usage

Description

Returns a list of records that reference this role mapping record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role-

mapping/27/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2299

Fortinet Inc.
Get /policy/role-mapping/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2300

Fortinet Inc.
Get /policy/role-mapping/{id}

Get /policy/role-mapping/{id}

Description

Return a list of role mapping records matching the supplied filter.

Request Parameter

Id, the Id of the role matching record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/role-mapping/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2301

Fortinet Inc.
Get /policy/role-mapping/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2302

Fortinet Inc.
Get /policy/role-mapping/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"roleID": 0,
"note": "string",
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"id": 0,
"name": ":-GdWsVU->:aFcsuc+:Y&q}E;$&4VWh,Kzdv_
Y~Md/F.*3JcK`tp8\\H/A(~fT,Wll7y+Z0l6xN+p.z0J\"",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-01-27T00:37:19.512Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"groupIDs": [
0
],
"accessValue": "string",
"groupNames": [
"string"
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API 0,
"liveDBID": 2303
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/role-mapping

Get /policy/role-mapping

Description

Return a list of role mapping records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/role-mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2304

Fortinet Inc.
Get /policy/role-mapping

Sample Response

FortiNAC F 7.4.0 REST API 2305

Fortinet Inc.
Get /policy/role-mapping

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"roleID": 0,
"note": "string",
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"id": 0,
"name": ":-GdWsVU->:aFcsuc+:Y&q}E;$&4VWh,Kzdv_
Y~Md/F.*3JcK`tp8\\H/A(~fT,Wll7y+Z0l6xN+p.z0J\"",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-01-27T00:37:19.512Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"groupIDs": [
0
],
"accessValue": "string",
"groupNames": [
"string"
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API 0,
"liveDBID": 2306
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/role-mapping/supporting-info

Get /policy/role-mapping/supporting-info

Description

Retrieves information necessary to create or modify a role mapping, such as Roles, Port and Device Groups, and CLI
configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/role-

mapping/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2307

Fortinet Inc.
Get /policy/role-mapping/supporting-info

Sample Response

{
"status": "success",
"errorMessage": null,
"roles": [
{
"dbid": 1,
"rank": 1,
"version": 0,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:28.000+0000",
"name": "GuestSelfRegistration",
"note": null,
"guid": null,
"globalModifiedDate": "2023-08-25T17:40:28.000+0000",
"auditObjectName": "GuestSelfRegistration",
"auditObjectType": {
"auditTableName": "RoleAudit",
"mysqlTableName": "Role",
"idnameQuery": "select ID,NAME from Role where ID in"
},
"auditObj": null,
"groupNames": [],
"yamsEventTag": "ROLE_MODIFICATION",
"groupIDs": []
}
],
"groups": [
{
"name": "Access Point Management",
"id": 1
}
],
"logicalNetworks": [],
"clis": []
}

FortiNAC F 7.4.0 REST API 2308

Fortinet Inc.
Get /policy/role-mapping/direct-configuration

Get /policy/role-mapping/direct-configuration

Description

Retrieves the current state of the Direct Configuration flag, used for determining if the legacy configuration mode is
available.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/role-

mapping/direct-configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2309

Fortinet Inc.
Get /policy/role-mapping/direct-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"result": false
}

FortiNAC F 7.4.0 REST API 2310

Fortinet Inc.
Get /policy/role-mapping/membership

Get /policy/role-mapping/membership

Description

View a list of the role(s) assigned to the selected device or port and the network access ID for that role on the device.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

elementID Required Integer

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/role-

mapping/membership

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body elementID: xxxxx

FortiNAC F 7.4.0 REST API 2311

Fortinet Inc.
Get /policy/role-mapping/membership

Sample Response

FortiNAC F 7.4.0 REST API 2312

Fortinet Inc.
Get /policy/role-mapping/membership

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"roleID": 0,
"note": "string",
"logicalNetwork": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-27T00:37:19.510Z",
"id": 0,
"name": ":-GdWsVU->:aFcsuc+:Y&q}E;$&4VWh,Kzdv_
Y~Md/F.*3JcK`tp8\\H/A(~fT,Wll7y+Z0l6xN+p.z0J\"",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-01-27T00:37:19.512Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"groupIDs": [
0
],
"accessValue": "string",
"groupNames": [
"string"
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-27T00:37:19.512Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API 0,
"liveDBID": 2313
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Post /policy/role-mapping

Post /policy/role-mapping

Description

Creates a new role mapping record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-mapping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.017Z",
"roleID": 0,
"note": "string",
"logicalNetwork": {
"id": 0,
"name": "oZl**~s[nr\"[Zs9|H
[5LkgD5;ZKgo4f:rRV)%YMUJ%fvEts%Qys\"s2H1!\\dZ_
%NVsG`iQ",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"dbid": 0,

FortiNAC F 7.4.0 REST API 2314

Fortinet Inc.
Post /policy/role-mapping

"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"filters": [
{
"dbid": 0,
"parent": "string",
"value": "string"
}
],
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"groupIDs": [
0
],
"accessValue": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {

FortiNAC F 7.4.0 REST API 2315

Fortinet Inc.
Post /policy/role-mapping

"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"cli": 0,
"roles": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.018Z",
"name": "string",
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"roleWildcard": true,
"cliobject": {
"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,

FortiNAC F 7.4.0 REST API 2316

Fortinet Inc.
Post /policy/role-mapping

"version": 0
},
"roleWildcarded": true,
"role": {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.018Z",
"name": "string",
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"logicalNetworkID": 0
}

FortiNAC F 7.4.0 REST API 2317

Fortinet Inc.
Post /policy/role-mapping

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2318

Fortinet Inc.
Post /policy/role-mapping/delete

Post /policy/role-mapping/delete

Description

Delete a list of role mapping records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-

mapping/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

FortiNAC F 7.4.0 REST API 2319

Fortinet Inc.
Post /policy/role-mapping/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2320

Fortinet Inc.
Post /policy/role-mapping/{id}

Post /policy/role-mapping/{id}

Description

Updates an role mapping record.

Request Parameter

Id, the Id of the role matching record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-mapping/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.017Z",
"roleID": 0,
"note": "string",
"logicalNetwork": {

FortiNAC F 7.4.0 REST API 2321

Fortinet Inc.
Post /policy/role-mapping/{id}

"id": 0,
"name": "oZl**~s[nr\"[Zs9|H
[5LkgD5;ZKgo4f:rRV)%YMUJ%fvEts%Qys\"s2H1!\\dZ_
%NVsG`iQ",
"description": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"filters": [
{
"dbid": 0,
"parent": "string",
"value": "string"
}
],
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"groupIDs": [
0
],
"accessValue": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"

FortiNAC F 7.4.0 REST API 2322

Fortinet Inc.
Post /policy/role-mapping/{id}

},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"cli": 0,
"roles": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.018Z",
"name": "string",
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}
],
"roleWildcard": true,
"cliobject": {

FortiNAC F 7.4.0 REST API 2323

Fortinet Inc.
Post /policy/role-mapping/{id}

"eventTag": "string",
"taskType": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
},
"roleWildcarded": true,
"role": {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-30T00:45:01.018Z",
"name": "string",
"groups": [
{
"dbid": 0,
"parent": "string",
"value": 0
}
],
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-01-30T00:45:01.018Z",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T00:45:01.018Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"logicalNetworkID": 0
}

FortiNAC F 7.4.0 REST API 2324

Fortinet Inc.
Post /policy/role-mapping/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2325

Fortinet Inc.
Post /policy/role-mapping/{id}/delete

Post /policy/role-mapping/{id}/delete

Description

Delete a single role mapping record by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-

mapping/27/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2326

Fortinet Inc.
Post /policy/role-mapping/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2327

Fortinet Inc.
Post /policy/role-mapping/rank/set

Post /policy/role-mapping/rank/set

Description

Sets the rank of supplied role mapping, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

rank Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-

mapping/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

rank: 3

FortiNAC F 7.4.0 REST API 2328

Fortinet Inc.
Post /policy/role-mapping/rank/set

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2329

Fortinet Inc.
Post /policy/role-mapping/rank/swap

Post /policy/role-mapping/rank/swap

Description

Swaps the rank position of the two supplied role mappings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Required Integer

id2 Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/role-

mapping/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 1

id2: 3

FortiNAC F 7.4.0 REST API 2330

Fortinet Inc.
Post /policy/role-mapping/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2331

Fortinet Inc.
Delete /policy/role-mapping/{id}

Delete /policy/role-mapping/{id}

Description

Deletes a single role mapping record by ID.

Request Parameter

Id, the Id of the role matching record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/role-mapping/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2332

Fortinet Inc.
Delete /policy/role-mapping/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2333

Fortinet Inc.
Scan Result

Scan Result

FortiNAC F 7.4.0 REST API 2334

Fortinet Inc.
Get /host/scan

Get /host/scan

Description

Returns all Scan Result records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scan

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2335

Fortinet Inc.
Get /host/scan

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"userID": "string",
"hostName": "string",
"policy": "string",
"location": "string",
"status": 0,
"type": 0,
"version": 0,
"testTime": 0,
"state": "string",
"macs": [
{}
],
"tests": [
{}
],
"operatingSystem": "string",
"applications": "string",
"epcconfigName": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2336

Fortinet Inc.
Get /host/scan/archives

Get /host/scan/archives

Description

Return the list of archived scan result available on the file system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scan/archives

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2337

Fortinet Inc.
Get /host/scan/archives

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
"RESULTS_Archive_2024_01_22_01_01_19_localhost.bua.gz",
"RESULTS_Archive_2024_01_29_01_01_19_localhost.bua.gz"
]
}

FortiNAC F 7.4.0 REST API 2338

Fortinet Inc.
Get /host/scan/archive/import/status

Get /host/scan/archive/import/status

Description

Returns the percentage completed for the most recent import of a Scan Results archive.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/scan/archive/import/status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2339

Fortinet Inc.
Get /host/scan/archive/import/status

Sample Response

{
"status": "success",
"errorMessage": null,
"result":""
}

FortiNAC F 7.4.0 REST API 2340

Fortinet Inc.
Get /host/scan/count

Get /host/scan/count

Description

Gets a count of Scan Results that match the provided filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scan/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2341

Fortinet Inc.
Get /host/scan/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"userID": "string",
"hostName": "string",
"policy": "string",
"location": "string",
"status": 0,
"type": 0,
"version": 0,
"testTime": 0,
"state": "string",
"macs": [
{}
],
"tests": [
{}
],
"epcconfigName": "string",
"operatingSystem": "string",
"applications": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2342

Fortinet Inc.
Get /host/scan/count/all

Get /host/scan/count/all

Description

Returns the count of all Scan Results in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scan/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2343

Fortinet Inc.
Get /host/scan/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"userID": "string",
"hostName": "string",
"policy": "string",
"location": "string",
"status": 0,
"type": 0,
"version": 0,
"testTime": 0,
"state": "string",
"macs": [
{}
],
"tests": [
{}
],
"epcconfigName": "string",
"operatingSystem": "string",
"applications": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2344

Fortinet Inc.
Get /host/scan/{id}

Get /host/scan/{id}

Description

Return the Scan Result record that matches the supplied DBID.

Request Parameter

Id, the Scanned Result record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scan/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2345

Fortinet Inc.
Get /host/scan/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"userID": "string",
"hostName": "string",
"policy": "string",
"location": "string",
"status": 0,
"type": 0,
"version": 0,
"testTime": 0,
"state": "string",
"macs": [
{}
],
"tests": [
{}
],
"epcconfigName": "string",
"operatingSystem": "string",
"applications": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2346

Fortinet Inc.
Post /host/scan/archive/create

Post /host/scan/archive/create

Description

Creates a new archive of all scans or set of scans by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/scan/archive/create

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body Id:9

FortiNAC F 7.4.0 REST API 2347

Fortinet Inc.
Post /host/scan/archive/create

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2348

Fortinet Inc.
Post /host/scan/archive/import

Post /host/scan/archive/import

Description

Imports the contents of a Scan Results archive into the database from the filesystem.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/scan/archive/import

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name:result

FortiNAC F 7.4.0 REST API 2349

Fortinet Inc.
Post /host/scan/archive/import

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2350

Fortinet Inc.
Scanned Application

Scanned Application

FortiNAC F 7.4.0 REST API 2351

Fortinet Inc.
Get /host/scanned-application

Get /host/scanned-application

Description

Return a list of Scanned Application record matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scanned-application

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2352

Fortinet Inc.
Get /host/scanned-application

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-01-30T21:56:38.634Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T21:56:38.634Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2353

Fortinet Inc.
Get /host/scanned-application/{id}

Get /host/scanned-application/{id}

Description

Return a list of Scanned Application record matching the supplied filter.

Request Parameter

Id, the Scanned Application record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scanned-application/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2354

Fortinet Inc.
Get /host/scanned-application/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-01-30T21:56:38.634Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T21:56:38.634Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2355

Fortinet Inc.
Get /host/scanned-application/for-host

Get /host/scanned-application/for-host

Description

Returns all Scanned Application that exist on the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

hostID Required Integer

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/host/scanned-

application/for-host

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body hostID:2

FortiNAC F 7.4.0 REST API 2356

Fortinet Inc.
Get /host/scanned-application/for-host

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"name": "string",
"packageName": "string",
"appVersion": "string",
"vendor": "string",
"os": "string",
"md5": "string",
"sha1": "string",
"sha256": "string",
"threatScore": 0,
"threatOverride": 0,
"submitDate": "2024-01-30T21:56:38.634Z",
"source": "string",
"verificationEngine": 0,
"osversion": "string",
"checksum": "string",
"checksumMethod": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-30T21:56:38.634Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2357

Fortinet Inc.
Get /host/scanned-application/{id}/usage

Get /host/scanned-application/{id}/usage

Description

Returns a list of records that reference this Scanned Application record.

Request Parameter

Id, the Id of the Scanned Application record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/host/scanned-

application/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:7

FortiNAC F 7.4.0 REST API 2358

Fortinet Inc.
Get /host/scanned-application/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2359

Fortinet Inc.
Post /host/scanned-application/delete

Post /host/scanned-application/delete

Description

Deletes a list of Scanned Application records with the supplied database ids.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/scanned-

application/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2360

Fortinet Inc.
Post /host/scanned-application/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2361

Fortinet Inc.
Post /host/scanned-application/threat

Post /host/scanned-application/threat

Description

Sets the Threat Level override for a Scanned Application, allowing it to be marked safe or unsafe.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

override Required Integer

appID Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/scanned-

application/for-host

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body override:1

appID:1

FortiNAC F 7.4.0 REST API 2362

Fortinet Inc.
Post /host/scanned-application/threat

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2363

Fortinet Inc.
Post /host/scanned-application/{id}/delete

Post /host/scanned-application/{id}/delete

Description

Deletes a single Scanned Application records by ID.

Request Parameter

Id, the Id of the Scanned Application record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/host/scanned-

application/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 2364

Fortinet Inc.
Post /host/scanned-application/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2365

Fortinet Inc.
Delete /host/scanned-application/{id}

Delete /host/scanned-application/{id}

Description

Deletes a single Scanned Application record by ID.

Request Parameter

Id, the Scanned Application record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/host/scanned-

application/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2366

Fortinet Inc.
Delete /host/scanned-application/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2367

Fortinet Inc.
Scheduler

Scheduler

FortiNAC F 7.4.0 REST API 2368

Fortinet Inc.
Get /system/scheduler

Get /system/scheduler

Description

Returns all scheduled task records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/system/scheduler

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2369

Fortinet Inc.
Get /system/scheduler

Sample Response

FortiNAC F 7.4.0 REST API 2370

Fortinet Inc.
Get /system/scheduler

{
"status": "string",
"errorMessage": "string",
"results": [
{
"eventTag": "string",
"type": "string",
"hidden": true,
"description": {
"description": "string",
"targets": "string",
"cmdLabel": "string",
"actionValue": "string",
"actionLabel": "string",
"cmdValue": "string",
"version": 0
},
"internalObject": {},
"taskTag": "string",
"multyDay": {
"days": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"version": 0
},
"scheduledTaskEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-31T00:16:37.195Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"period": 0,
"previousScheduledTime": "2024-01-31T00:16:37.196Z",
"scheduledTime": "2024-01-31T00:16:37.196Z",
"pause": true,
"name": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2371

Fortinet Inc.
Get /system/scheduler/{id}

Get /system/scheduler/{id}

Description

Returns the scheduled task record with the supplied DBID.

Request Parameter

Id, the schedule task record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/system/scheduler/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2372

Fortinet Inc.
Get /system/scheduler/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2373

Fortinet Inc.
Get /system/scheduler/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"eventTag": "string",
"type": "string",
"hidden": true,
"description": {
"description": "string",
"targets": "string",
"cmdLabel": "string",
"actionValue": "string",
"actionLabel": "string",
"cmdValue": "string",
"version": 0
},
"internalObject": {},
"taskTag": "string",
"multyDay": {
"days": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"version": 0
},
"scheduledTaskEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-31T00:16:37.195Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"period": 0,
"previousScheduledTime": "2024-01-31T00:16:37.196Z",
"scheduledTime": "2024-01-31T00:16:37.196Z",
"pause": true,
"name": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2374

Fortinet Inc.
Get /system/scheduler/count/all

Get /system/scheduler/count/all

Description

Returns the count of all scheduled task records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/scheduler/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2375

Fortinet Inc.
Get /system/scheduler/count/all

Sample Response

FortiNAC F 7.4.0 REST API 2376

Fortinet Inc.
Get /system/scheduler/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"eventTag": "string",
"type": "string",
"hidden": true,
"description": {
"description": "string",
"targets": "string",
"cmdLabel": "string",
"actionValue": "string",
"actionLabel": "string",
"cmdValue": "string",
"version": 0
},
"internalObject": {},
"taskTag": "string",
"multyDay": {
"days": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"version": 0
},
"scheduledTaskEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-31T00:16:37.195Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"period": 0,
"previousScheduledTime": "2024-01-31T00:16:37.196Z",
"scheduledTime": "2024-01-31T00:16:37.196Z",
"pause": true,
"name": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2377

Fortinet Inc.
Get /system/scheduler/count

Get /system/scheduler/count

Description

Returns a count of scheduled task records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/scheduler/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2378

Fortinet Inc.
Get /system/scheduler/count

Sample Response

FortiNAC F 7.4.0 REST API 2379

Fortinet Inc.
Get /system/scheduler/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"eventTag": "string",
"type": "string",
"hidden": true,
"description": {
"description": "string",
"targets": "string",
"cmdLabel": "string",
"actionValue": "string",
"actionLabel": "string",
"cmdValue": "string",
"version": 0
},
"internalObject": {},
"taskTag": "string",
"multyDay": {
"days": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"version": 0
},
"scheduledTaskEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-01-31T00:16:37.195Z",
"version": 0,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"period": 0,
"previousScheduledTime": "2024-01-31T00:16:37.196Z",
"scheduledTime": "2024-01-31T00:16:37.196Z",
"pause": true,
"name": "string",
"state": "string",
"id": 0,
"landscape": 0,
"version": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2380

Fortinet Inc.
Get /system/scheduler/{name}/running

Get /system/scheduler/{name}/running

Description

Returns if the provided scheduled task is currently running.

Request Parameter

Name, the name of the schedule task.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/scheduler/"System

Backup"/running

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2381

Fortinet Inc.
Get /system/scheduler/{name}/running

Sample Response

{
"status": "success",
"errorMessage": null,
"result":false
}

FortiNAC F 7.4.0 REST API 2382

Fortinet Inc.
Get /system/scheduler/activity-types

Get /system/scheduler/activity-types

Description

Returns the full set of activity types known to the scheduler.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/scheduler/activity-types

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2383

Fortinet Inc.
Get /system/scheduler/activity-types

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"Enable Ports": "PORT_ON",
"Custom Script": "SYSTEM_COMMAND",
"Resynchronize Device": "RESYNC_DEVICE",
"Synchronize Users from Directory": "SYNC_DIRECTORY",
"Check for OS Updates": "OS_UPDATE_STATUS",
"Verify DHCP Servers": "VERIFY_DHCP",
"Auto-Definition Synchronizer": "AUTO_DEFINITION_SYNCHRONIZER",
"System Backup": "SYSTEM_BACKUP",
"Host At Risk": "CLIENT_AT_RISK",
"Certificate Expiration Monitor": "CERT_EXPIRATION_MONITOR",
"Report Generation": "REPORT_GENERATION",
"Role Assignment": "PREFERRED_VLAN_UPDATE",
"Update Default VLAN Values": "SWITCH_DEFAULT_VLAN_PORT",
"Enable Host": "CLIENT_ON",
"CLI Configuration": "CLI_CONFIG",
"Enable HP/NT Port Security": "ENABLE_HP_SECURITY",
"Disable Host": "CLIENT_OFF",
"Enable Adapters": "ENABLE_CLIENTS",
"SSID Assignment": "UPDATE_SSID",
"Update Interface Status": "UPDATE_INTERFACE_STATUS",
"Disable Ports": "PORT_OFF",
"Port Vlan Switch": "PORT_VLAN_SWITCH",
"Agentless Host Scanning": "AGENTLESS_HOST_PROFILE_TASK",
"Database Backup": "DATABASE_BACKUP",
"Disable HP/NT Port Security": "DISABLE_HP_SECURITY",
"Policy Rescan": "RESCAN_AGENT_POLICY",
"Command Line Script": "COMMAND_SCRIPT",
"Host Safe": "CLIENT_SAFE",
"Security Rescan": "SECURITY_RESCAN",
"Disable Adapters": "DISABLE_CLIENTS",
"Packeteer Configuration": "PACKETEER_CLI",
"Database Archive and Purge": "EVENT_ARCHIVE_AND_PURGE",
"Modify Device VLAN Values": "SWITCH_VLAN_PORT"
}
}

FortiNAC F 7.4.0 REST API 2384

Fortinet Inc.
Post /system/scheduler/delete

Post /system/scheduler/delete

Description

Deletes the scheduled task record or records supplied, if they are none are currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/scheduler/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 5

FortiNAC F 7.4.0 REST API 2385

Fortinet Inc.
Post /system/scheduler/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2386

Fortinet Inc.
Post /system/scheduler/{id}/delete

Post /system/scheduler/{id}/delete

Description

Deletes the scheduled task record or records supplied, if they are none are currently in use.

Request Parameter

Id, the Id of the scheduled task.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/scheduler/5/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2387

Fortinet Inc.
Post /system/scheduler/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2388

Fortinet Inc.
Post /system/scheduler/{id}/disable

Post /system/scheduler/{id}/disable

Description

Disables the supplied scheduled task.

Request Parameter

Id, the Id of the scheduled task.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/scheduler/3/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2389

Fortinet Inc.
Post /system/scheduler/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null,
"result": null
}

FortiNAC F 7.4.0 REST API 2390

Fortinet Inc.
Post /system/scheduler/{id}/enable

Post /system/scheduler/{id}/enable

Description

Enables the supplied scheduled task.

Request Parameter

Id, the Id of the scheduled task.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/scheduler/3/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2391

Fortinet Inc.
Post /system/scheduler/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null,
"result": null
}

FortiNAC F 7.4.0 REST API 2392

Fortinet Inc.
Post /system/scheduler/run

Post /system/scheduler/run

Description

Runs one or more scheduled tasks with the supplied IDs.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/scheduler/run

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:1

FortiNAC F 7.4.0 REST API 2393

Fortinet Inc.
Post /system/scheduler/run

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2394

Fortinet Inc.
Delete /system/scheduler/{id}

Delete /system/scheduler/{id}

Description

Deletes the scheduled task record supplied, if it is not currently in use.

Request Parameter

Id, the schedule task record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/system/scheduler/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2395

Fortinet Inc.
Delete /system/scheduler/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2396

Fortinet Inc.
Security Event

Security Event

FortiNAC F 7.4.0 REST API 2397

Fortinet Inc.
Get /policy/security-event

Get /policy/security-event

Description

Returns a list of Security Event records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/security-event

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2398

Fortinet Inc.
Get /policy/security-event

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"eventDate": "2024-01-31T22:34:32.372Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T22:34:32.372Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2399

Fortinet Inc.
Get /policy/security-alarm

Get /policy/security-alarm

Description

Returns a list of Security Alarm records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/security-alarm

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2400

Fortinet Inc.
Get /policy/security-alarm

Sample Response

FortiNAC F 7.4.0 REST API 2401

Fortinet Inc.
Get /policy/security-alarm

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"hostID": 0,
"hostMac": "string",
"eventDate": "2024-01-31T19:25:00.752Z",
"ruleText": "string",
"actionText": "string",
"eventAction": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-31T19:25:00.752Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-01-31T19:25:00.752Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API
"liveDBID": 0, 2402
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/security-alarm/{id}

Get /policy/security-alarm/{id}

Description

Returns a list of Security Alarm records matching the supplied filter.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/security-alarm/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2403

Fortinet Inc.
Get /policy/security-alarm/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2404

Fortinet Inc.
Get /policy/security-alarm/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"hostID": 0,
"hostMac": "string",
"eventDate": "2024-01-31T19:25:00.752Z",
"ruleText": "string",
"actionText": "string",
"eventAction": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-31T19:25:00.752Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-01-31T19:25:00.752Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API
"liveDBID": 0, 2405
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/security-alarm/{id}/monitor

Get /policy/security-alarm/{id}/monitor

Description

Gets all changes to Security Alarms since the alarms were last polled.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-

alarm/1/monitor

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2406

Fortinet Inc.
Get /policy/security-alarm/{id}/monitor

Sample Response

FortiNAC F 7.4.0 REST API 2407

Fortinet Inc.
Get /policy/security-alarm/{id}/monitor

{
"status": "string",
"errorMessage": "string",
"removed":[
0
],
"added": [
{
"dbid": 0,
"rank": 0,
"hostID": 0,
"hostMac": "string",
"eventDate": "2024-01-31T19:25:00.752Z",
"ruleText": "string",
"actionText": "string",
"eventAction": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-31T19:25:00.752Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-01-31T19:25:00.752Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
FortiNAC F 7.4.0 REST API
"auditObj": "string" 2408
Fortinet Inc. },
"auditDBID": 0,
"liveDBID": 0,
Get /policy/security-event/{id}

Get /policy/security-event/{id}

Description

Returns a list of Security Event records matching the supplied filter.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/policy/security-event/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2409

Fortinet Inc.
Get /policy/security-event/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"eventDate": "2024-01-31T22:34:32.372Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T22:34:32.372Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2410

Fortinet Inc.
Get /policy/security-event-summary/hosts/isolated

Get /policy/security-event-summary/hosts/isolated

Description

Queries all Hosts which have an active Disabling action from a Security Alarm.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/hosts/isolated

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2411

Fortinet Inc.
Get /policy/security-event-summary/hosts/isolated

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2412

Fortinet Inc.
Get /policy/security-event-summary/alarms/top

Get /policy/security-event-summary/alarms/top

Description

Returns the least or more frequently appearing Alarms as determined by the Rule Text during the specified time range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

numResults Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/alarms/top

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2413

Fortinet Inc.
Get /policy/security-event-summary/alarms/top

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"status": "success",
"errorMessage": null,
"alarmCounts": []
}
}

FortiNAC F 7.4.0 REST API 2414

Fortinet Inc.
Get /policy/security-event-summary/events/top

Get /policy/security-event-summary/events/top

Description

Returns the least or most frequently appearing Security Events as determined by Event Description during the specified
time range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

minSev Optional Integer

maxSev Optional Integer

numResults Optional Integer

topEvents Optional Boolean

FortiNAC F 7.4.0 REST API 2415

Fortinet Inc.
Get /policy/security-event-summary/events/top

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/events/top

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"status": "success",
"errorMessage": null,
"eventCounts": []
}
}

FortiNAC F 7.4.0 REST API 2416

Fortinet Inc.
Get /policy/security-event-summary/dash-security-hosts-for-alarm

Get /policy/security-event-summary/dash-security-hosts-
for-alarm

Description

Returns a list of hosts that generated the provided alarm for the specified date range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

ruleName Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/dash-security-hosts-for-alarm

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2417

Fortinet Inc.
Get /policy/security-event-summary/dash-security-hosts-for-alarm

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"status": "string",
"errorMessage": "string",
"hostCounts": [
{
"id": 0,
"host": "string",
"user": "string",
"os": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2418

Fortinet Inc.
Get /policy/security-event-summary/hosts/top

Get /policy/security-event-summary/hosts/top

Description

Returns the least or more frequently appearing Hosts associated with Security Events during the specified time range.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

minSev Optional Integer

maxSev Optional Integer

numResults Optional Integer

topEvents Optional Boolean

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/hosts/top

FortiNAC F 7.4.0 REST API 2419

Fortinet Inc.
Get /policy/security-event-summary/hosts/top

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"status": "string",
"errorMessage": "string",
"hostCounts": [
{
"index": 0,
"total": 0,
"mac": "string",
"hostID": 0,
"hostName": "string",
"userName": "string",
"os": "string"
}
]
}
}

FortiNAC F 7.4.0 REST API 2420

Fortinet Inc.
Get /policy/security-event-summary/hosts/remediated

Get /policy/security-event-summary/hosts/remediated

Description

Queries all Hosts which were previously disabled by a Security Alarm that has been undone.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/hosts/isolated

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2421

Fortinet Inc.
Get /policy/security-event-summary/hosts/remediated

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2422

Fortinet Inc.
Get /policy/security-event-summary/statistics

Get /policy/security-event-summary/statistics

Description

Retrieves overall statistics about Security Events, Security Alarms, and the associated Hosts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

startDate Optional Integer

endDate Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-event-

summary/statistics

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2423

Fortinet Inc.
Get /policy/security-event-summary/statistics

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"status": "success",
"errorMessage": null,
"startDate": "1969-12-31",
"endDate": "1969-12-31",
"totalEventsRecorded": 0,
"totalAlarms": 0,
"hostsGeneratingAlarms": 0,
"totalEventsReceived": 0,
"totalEventsDiscarded": 0,
"totalHostsIsolated": 0,
"totalHostsRemediated": 0,
"totalKnownHosts": 0,
"totalUnknownHosts": 0,
"eventsUsedInAlarms": 0,
"alarmsWithActionNotTaken": 0,
"alarmsWithActionTaken": 0,
"alarmsWithActionTakenAndUndone": 0,
"success": false,
"error": null
}
}

FortiNAC F 7.4.0 REST API 2424

Fortinet Inc.
Get /policy/security-event/{id}/monitor

Get /policy/security-event/{id}/monitor

Description

Gets all changes to Security Event records since the Events were last polled.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-

event/0/monitor

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2425

Fortinet Inc.
Get /policy/security-event/{id}/monitor

Sample Response

{
"status": "string",
"errorMessage": "string",
"removed": [
0
],
"added": [
{
"dbid": 0,
"eventDate": "2024-01-31T22:34:32.372Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T22:34:32.372Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2426

Fortinet Inc.
Post /policy/security-alarm/monitor/start

Post /policy/security-alarm/monitor/start

Description

Begins collecting changes made to Security Alarms matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

alarm/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2427

Fortinet Inc.
Post /policy/security-alarm/monitor/start

Sample Response

FortiNAC F 7.4.0 REST API 2428

Fortinet Inc.
Post /policy/security-alarm/monitor/start

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"hostID": 0,
"hostMac": "string",
"eventDate": "2024-01-31T19:25:00.752Z",
"ruleText": "string",
"actionText": "string",
"eventAction": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-31T19:25:00.752Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-01-31T19:25:00.752Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T19:25:00.752Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
FortiNAC F 7.4.0 REST API
"liveDBID": 0, 2429
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Post /policy/security-event/{id}/monitor/stop

Post /policy/security-event/{id}/monitor/stop

Description

Stops collecting changes made to Security Event records matching the supplied filter.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

event/2/monitor/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2430

Fortinet Inc.
Post /policy/security-event/{id}/monitor/stop

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2431

Fortinet Inc.
Post /policy/security-event/monitor/start

Post /policy/security-event/monitor/start

Description

Begins collecting changes made to Security Event records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

event/monitor/start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2432

Fortinet Inc.
Post /policy/security-event/monitor/start

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"eventDate": "2024-01-31T22:34:32.372Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-01-31T22:34:32.372Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2433

Fortinet Inc.
Post /policy/security-alarm/{id}/monitor/stop

Post /policy/security-alarm/{id}/monitor/stop

Description

Stops collecting changes made to Security Alarms for the specified monitor.

Request Parameter

Id, the Id of the Security Alarm record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

alarm/1/monitor/stop

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2434

Fortinet Inc.
Post /policy/security-alarm/{id}/monitor/stop

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2435

Fortinet Inc.
Security Event Parser

Security Event Parser

FortiNAC F 7.4.0 REST API 2436

Fortinet Inc.
Get /settings/integration/security-event-parser

Get /settings/integration/security-event-parser

Description

Returns a list of Security Event Parser records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2437

Fortinet Inc.
Get /settings/integration/security-event-parser

Sample Response

FortiNAC F 7.4.0 REST API 2438

Fortinet Inc.
Get /settings/integration/security-event-parser

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 9,
"isRTR": true,
"isEnabled": true,
"name": "StoneGate",
"vendor": "StoneGate",
"format": 1,
"delimiter": ",",
"tagDelimiter": "=",
"sourceIPColumn": "5",
"sourceIPMatcher": ".*",
"sourceIPValue": "$0",
"destinationIPColumn": "",
"destinationIPMatcher": ".*",
"destinationIPValue": "$0",
"typeColumn": "",
"typeMatcher": ".*",
"typeValue": "$0",
"subtypeColumn": "",
"subtypeMatcher": ".*",
"subtypeValue": "$0",
"threatIDColumn": "",
"threatIDMatcher": ".*",
"threatIDValue": "$0",
"descriptionColumn": "",
"descriptionMatcher": ".*",
"descriptionValue": "$0",
"severityColumn": "3",
"severityMatcher": ".*",
"severityValue": "$0",
"severityMap": {
"0": 1,
"1": 2,
"2": 3,
"3": 4,
"4": 5,
"5": 6,
"6": 7,
"7": 8,
"8": 9,
"9": 10
},
"auditObjectName": "StoneGate",
"auditObjectType": {
"auditTableName": "RTRSecurityEventParserAudit",
"mysqlTableName": "RTRSecurityEventParser",
"idnameQuery": "select ID,name from RTRSecurityEventParser where
ID in"
},
"auditObj": null,
"yamsEventTag": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:28.000+0000"
}
],
"filtered": 1,
FortiNAC F 7.4.0 REST
"total": 1 API 2439
Fortinet
} Inc.
Get /settings/integration/security-event-parser/{id}

Get /settings/integration/security-event-parser/{id}

Description

Returns a list of Security Event Parser records matching the supplied filter.

Request Parameter

Id, the Id of the Security Event Parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2440

Fortinet Inc.
Get /settings/integration/security-event-parser/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2441

Fortinet Inc.
Get /settings/integration/security-event-parser/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 9,
"isRTR": true,
"isEnabled": true,
"name": "StoneGate",
"vendor": "StoneGate",
"format": 1,
"delimiter": ",",
"tagDelimiter": "=",
"sourceIPColumn": "5",
"sourceIPMatcher": ".*",
"sourceIPValue": "$0",
"destinationIPColumn": "",
"destinationIPMatcher": ".*",
"destinationIPValue": "$0",
"typeColumn": "",
"typeMatcher": ".*",
"typeValue": "$0",
"subtypeColumn": "",
"subtypeMatcher": ".*",
"subtypeValue": "$0",
"threatIDColumn": "",
"threatIDMatcher": ".*",
"threatIDValue": "$0",
"descriptionColumn": "",
"descriptionMatcher": ".*",
"descriptionValue": "$0",
"severityColumn": "3",
"severityMatcher": ".*",
"severityValue": "$0",
"severityMap": {
"0": 1,
"1": 2,
"2": 3,
"3": 4,
"4": 5,
"5": 6,
"6": 7,
"7": 8,
"8": 9,
"9": 10
},
"auditObjectName": "StoneGate",
"auditObjectType": {
"auditTableName": "RTRSecurityEventParserAudit",
"mysqlTableName": "RTRSecurityEventParser",
"idnameQuery": "select ID,name from RTRSecurityEventParser where
ID in"
},
"auditObj": null,
"yamsEventTag": null,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:28.000+0000"
}
],
"filtered": 1,
FortiNAC F 7.4.0 REST
"total": 44 API 2442
Fortinet
} Inc.
Get /settings/integration/security-event-parser/recent-syslog

Get /settings/integration/security-event-parser/recent-
syslog

Description

Returns several recently received syslog messages in pairs of source IP and message text.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/recent-syslog

FortiNAC F 7.4.0 REST API 2443

Fortinet Inc.
Get /settings/integration/security-event-parser/recent-syslog

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"first": "string",
"second": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2444

Fortinet Inc.
Get /settings/integration/security-event-parser/{id}/usage

Get /settings/integration/security-event-parser/{id}/usage

Description

Returns a list of records that reference this Security Event Parser record.

Request Parameter

Id, the Id of the Security Event Parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2445

Fortinet Inc.
Get /settings/integration/security-event-parser/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2446

Fortinet Inc.
Post /settings/integration/security-event-parser

Post /settings/integration/security-event-parser

Description

Creates a new Security Event Parser record, updating instead if the supplied profile has a DBID of tone that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"isRTR": true,
"isEnabled": true,
"name": "string",
"vendor": "string",
"format": 0,
"delimiter": "string",
"tagDelimiter": "string",
"sourceIPColumn": "string",
"sourceIPMatcher": "string",
"sourceIPValue": "string",
"destinationIPColumn": "string",
"destinationIPMatcher": "string",
"destinationIPValue": "string",

FortiNAC F 7.4.0 REST API 2447

Fortinet Inc.
Post /settings/integration/security-event-parser

"typeColumn": "string",
"typeMatcher": "string",
"typeValue": "string",
"subtypeColumn": "string",
"subtypeMatcher": "string",
"subtypeValue": "string",
"threatIDColumn": "string",
"threatIDMatcher": "string",
"threatIDValue": "string",
"descriptionColumn": "string",
"descriptionMatcher": "string",
"descriptionValue": "string",
"severityColumn": "string",
"severityMatcher": "string",
"severityValue": "string",
"severityMap": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-01T22:42:51.889Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2448

Fortinet Inc.
Post /settings/integration/security-event-parser

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2449

Fortinet Inc.
Post /settings/integration/security-event-parser/delete

Post /settings/integration/security-event-parser/delete

Description

Deletes a list of Security Event Parser records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 2450

Fortinet Inc.
Post /settings/integration/security-event-parser/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2451

Fortinet Inc.
Post /settings/integration/security-event-parser/disable

Post /settings/integration/security-event-parser/disable

Description

Disables the supplied Security Event Parser.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 2452

Fortinet Inc.
Post /settings/integration/security-event-parser/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2453

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}

Post /settings/integration/security-event-parser/{id}

Description

Updates a Security Event Parser record.

Request Parameter

Id, the Id of the Security Event Parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"isRTR": true,
"isEnabled": true,
"name": "string",
"vendor": "string",
"format": 0,
"delimiter": "string",
"tagDelimiter": "string",

FortiNAC F 7.4.0 REST API 2454

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}

"sourceIPColumn": "string",
"sourceIPMatcher": "string",
"sourceIPValue": "string",
"destinationIPColumn": "string",
"destinationIPMatcher": "string",
"destinationIPValue": "string",
"typeColumn": "string",
"typeMatcher": "string",
"typeValue": "string",
"subtypeColumn": "string",
"subtypeMatcher": "string",
"subtypeValue": "string",
"threatIDColumn": "string",
"threatIDMatcher": "string",
"threatIDValue": "string",
"descriptionColumn": "string",
"descriptionMatcher": "string",
"descriptionValue": "string",
"severityColumn": "string",
"severityMatcher": "string",
"severityValue": "string",
"severityMap": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-01T22:42:51.889Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2455

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2456

Fortinet Inc.
Post /settings/integration/security-event-parser/parse-message

Post /settings/integration/security-event-parser/parse-
message

Description

Attempts to parse a message using the supplied format and delimiters. On a successful parse of a message, the
name/value pairs are returned for the user to use when building a parser.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

message Optional String

format Optional Integer

delimiter Optional String

tagDelimiter Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/parse-message

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2457

Fortinet Inc.
Post /settings/integration/security-event-parser/parse-message

Content-Type: application/json

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2458

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}/delete

Post /settings/integration/security-event-parser/{id}/delete

Description

Deletes a single Security Event Parser record by ID.

Request Parameter

Id, the Id of the Security Event Parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2459

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2460

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}/test

Post /settings/integration/security-event-parser/{id}/test

Description

Tests parsing a text value into a Security Event, including debug information from the parsing process.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"firstRecord": 0,
"count": true,
"cacheable": true,
"distinct": true,
"queryFilters": [
[
{
"origPropName": "string",
"matchNull": true,
"matchNonNull": true,
"actualValue": {},
"notFilter": true,
"values": [
{}
],

FortiNAC F 7.4.0 REST API 2461

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}/test

"stringValue": "string",
"enabled": true,
"debugString": "string",
"propName": "string",
"criterion": {},
"allowNotFilter": true,
"allowMultiTermFilter": true
}
]
],
"vendor": "string",
"format": 0,
"delimiter": "string",
"sourceIPColumn": "string",
"sourceIPMatcher": "string",
"sourceIPValue": "string",
"destinationIPColumn": "string",
"destinationIPMatcher": "string",
"destinationIPValue": "string",
"typeColumn": "string",
"typeMatcher": "string",
"typeValue": "string",
"subtypeColumn": "string",
"subtypeMatcher": "string",
"subtypeValue": "string",
"threatIDColumn": "string",
"threatIDMatcher": "string",
"threatIDValue": "string",
"descriptionColumn": "string",
"descriptionMatcher": "string",
"descriptionValue": "string",
"severityMatcher": "string",
"severityValue": "string",
"isRTR": true,
"severityColumn": "string",
"isEnabled": true,
"name": "string",
"dbid": 0,
"ordering": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"countFilter": true,
"resultLimit": 0
}

FortiNAC F 7.4.0 REST API 2462

Fortinet Inc.
Post /settings/integration/security-event-parser/{id}/test

Sample Response

{
"status": "string",
"errorMessage": "string",
"debug": "string",
"event": {
"dbid": 0,
"eventDate": "2024-02-01T23:31:23.055Z",
"deviceID": 0,
"sourceIP": "string",
"sourceMac": "string",
"destinationIP": "string",
"destinationMac": "string",
"alertType": "string",
"subtype": "string",
"severity": 0,
"threatID": "string",
"eventDescription": "string",
"sourceLocation": "string",
"destinationLocation": "string",
"vendor": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-01T23:31:23.055Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
}

FortiNAC F 7.4.0 REST API 2463

Fortinet Inc.
Post /settings/integration/security-event-parser/enable

Post /settings/integration/security-event-parser/enable

Description

Enables the supplied Security Event Parser.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 9

FortiNAC F 7.4.0 REST API 2464

Fortinet Inc.
Post /settings/integration/security-event-parser/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2465

Fortinet Inc.
Delete /settings/integration/security-event-parser/{id}

Delete /settings/integration/security-event-parser/{id}

Description

Deletes a single Security Event Parser record by ID.

Request Parameter

Id, the Id of the Security Event Parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/security-

event-parser/9

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2466

Fortinet Inc.
Delete /settings/integration/security-event-parser/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2467

Fortinet Inc.
Security Mgmnt Properties

Security Mgmnt Properties

FortiNAC F 7.4.0 REST API 2468

Fortinet Inc.
Get /settings/agent/properties

Get /settings/agent/properties

Description

Returns a list of security management properties for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2469

Fortinet Inc.
Get /settings/agent/properties

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"vmDetection": "string",
"onConnectHostGroup": "string",
"requireConnectedAdapter": {
"enabled": "string",
"ipv4Ranges": [
"string"
],
"ipv6Ranges": [
"string"
]
},
"expirationEnabled": "string",
"expirationTime": "string",
"networkChangeMsg": "string",
"invalidOUIMsg": "string",
"failedReg": "string",
"failedScan": "string",
"warnMsg": "string",
"successReg": "string",
"reAuthPrompt": "string",
"loginPrompt": "string",
"userNameLabel": "string",
"passwordLabel": "string",
"displayNotifications": "string",
"secondaryHostName": "string",
"hostConnectGracePeriod": "string",
"agentDisconnectGracePeriod": "string",
"hostDisconnectGracePeriod": "string",
"connectExternalHostsGroup": "string",
"header": "string",
"footer": "string",
"cacheStrategy": "string",
"cacheStrategyPollInterval": "string",
"cacheStrategyExpireTime": "string",
"remediationMsg": "string",
"paConfigForHA": "string",
"showExpiration": "string",
"hostName": "string",
"hostGroups": [
{
"name": "string",
"nameLabel": "string",
"id": "string"
}
]
}
}

FortiNAC F 7.4.0 REST API 2470

Fortinet Inc.
Post /settings/agent/properties

Post /settings/agent/properties

Description

Configures security management properties for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Post https://10.106.94.152:8443/api/v2/settings/agent/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"result": {
"vmDetection": "string",
"onConnectHostGroup": "string",
"requireConnectedAdapter": {
"enabled": "string",
"ipv4Ranges": [
"string"
],
"ipv6Ranges": [
"string"
]
},
"expirationEnabled": "string",
"expirationTime": "string",

FortiNAC F 7.4.0 REST API 2471

Fortinet Inc.
Post /settings/agent/properties

"networkChangeMsg": "string",
"invalidOUIMsg": "string",
"failedReg": "string",
"failedScan": "string",
"warnMsg": "string",
"successReg": "string",
"reAuthPrompt": "string",
"loginPrompt": "string",
"userNameLabel": "string",
"passwordLabel": "string",
"displayNotifications": "string",
"secondaryHostName": "string",
"hostConnectGracePeriod": "string",
"agentDisconnectGracePeriod": "string",
"hostDisconnectGracePeriod": "string",
"connectExternalHostsGroup": "string",
"header": "string",
"footer": "string",
"cacheStrategy": "string",
"cacheStrategyPollInterval": "string",
"cacheStrategyExpireTime": "string",
"remediationMsg": "string",
"paConfigForHA": "string",
"showExpiration": "string",
"hostName": "string",
"hostGroups": [
{
"name": "string",
"nameLabel": "string",
"id": "string"
}
]
}
}

FortiNAC F 7.4.0 REST API 2472

Fortinet Inc.
Post /settings/agent/properties

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2473

Fortinet Inc.
Security Rule

Security Rule

FortiNAC F 7.4.0 REST API 2474

Fortinet Inc.
Get /policy/security-rule

Get /policy/security-rule

Description

Returns a list of Security Rule records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-rule

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2475

Fortinet Inc.
Get /policy/security-rule

Sample Response

FortiNAC F 7.4.0 REST API 2476

Fortinet Inc.
Get /policy/security-rule

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"enabled": true,
"name": "string",
"description": "string",
"trigger": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
FortiNAC F 7.4.0 "liveObj":
REST API { 2477
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/security-rule-trigger

Get /policy/security-rule-trigger

Description

Returns a list of Security Trigger records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2478

Fortinet Inc.
Get /policy/security-rule-trigger

Sample Response

FortiNAC F 7.4.0 REST API 2479

Fortinet Inc.
Get /policy/security-rule-trigger

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-06T22:45:48.893Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T22:45:48.893Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T22:45:48.893Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
FortiNAC F 7.4.0 REST API
"auditObjectName": "string", 2480
Fortinet Inc. "auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
Get /policy/security-rule/{id}

Get /policy/security-rule/{id}

Description

Returns a list of Security Rule records matching the supplied filter.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-rule/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2481

Fortinet Inc.
Get /policy/security-rule/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2482

Fortinet Inc.
Get /policy/security-rule/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"enabled": true,
"name": "string",
"description": "string",
"trigger": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
FortiNAC F 7.4.0 "liveObj":
REST API { 2483
Fortinet Inc. "yamsEventTag": "string",
"auditObj": "string"
},
Get /policy/security-rule-trigger/{id}/usage

Get /policy/security-rule-trigger/{id}/usage

Description

Returns a list of records that reference this Security Trigger record.

Request Parameter

Id, the Security Trigger record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2484

Fortinet Inc.
Get /policy/security-rule-trigger/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"children": [
"string"
],
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2485

Fortinet Inc.
Get /policy/security-rule-trigger/{id}

Get /policy/security-rule-trigger/{id}

Description

Returns a list of Security Trigger records matching the supplied filter.

Request Parameter

Id, the Security Trigger record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2486

Fortinet Inc.
Get /policy/security-rule-trigger/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2487

Fortinet Inc.
Get /policy/security-rule-trigger/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-06T22:45:48.893Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T22:45:48.893Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T22:45:48.893Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
FortiNAC F 7.4.0 REST API
"auditObjectName": "string", 2488
Fortinet Inc. "auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
Post /policy/security-rule

Post /policy/security-rule

Description

Creates a new Security Rule record updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"enabled": true,
"name": "string",
"description": "string",
"trigger": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [

FortiNAC F 7.4.0 REST API 2489

Fortinet Inc.
Post /policy/security-rule

{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},

FortiNAC F 7.4.0 REST API 2490

Fortinet Inc.
Post /policy/security-rule

"hostProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],

FortiNAC F 7.4.0 REST API 2491

Fortinet Inc.
Post /policy/security-rule

"locationNames": [
"string"
]
},
"conditionState": "string",
"triggerEmailGroup": 0,
"actionEmailGroup": 0,
"actionState": "string",
"action": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},

FortiNAC F 7.4.0 REST API 2492

Fortinet Inc.
Post /policy/security-rule

"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2493

Fortinet Inc.
Post /policy/security-rule

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2494

Fortinet Inc.
Post /policy/security-rule/delete

Post /policy/security-rule/delete

Description

Deletes a list of Security Rule records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 2

FortiNAC F 7.4.0 REST API 2495

Fortinet Inc.
Post /policy/security-rule/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2496

Fortinet Inc.
Post /policy/security-rule/{id}/disable

Post /policy/security-rule/{id}/disable

Description

Disables the supplied Security Rule.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/1/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2497

Fortinet Inc.
Post /policy/security-rule/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2498

Fortinet Inc.
Post /policy/security-rule/{id}/enable

Post /policy/security-rule/{id}/enable

Description

Enables the supplied Security Rule.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/1/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2499

Fortinet Inc.
Post /policy/security-rule/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2500

Fortinet Inc.
Post /policy/security-rule/{id}/delete

Post /policy/security-rule/{id}/delete

Description

Deletes a single Security Rule record by ID.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2501

Fortinet Inc.
Post /policy/security-rule/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2502

Fortinet Inc.
Post /policy/security-rule/{id}

Post /policy/security-rule/{id}

Description

Updates an Security Rule record.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"enabled": true,
"name": "string",
"description": "string",

FortiNAC F 7.4.0 REST API 2503

Fortinet Inc.
Post /policy/security-rule/{id}

"trigger": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"

FortiNAC F 7.4.0 REST API 2504

Fortinet Inc.
Post /policy/security-rule/{id}

},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"hostProfile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",

FortiNAC F 7.4.0 REST API 2505

Fortinet Inc.
Post /policy/security-rule/{id}

"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
},
"conditionState": "string",
"triggerEmailGroup": 0,
"actionEmailGroup": 0,
"actionState": "string",
"action": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-02T00:28:33.416Z",
"dbid": 0,
"name": "string",
"guid": 0,
"globalModifiedDate": "2024-02-02T00:28:33.416Z",
"onFailure": "string",
"secondaryActionTimer": 0,
"activities": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"type": "string",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"typeDescription": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",

FortiNAC F 7.4.0 REST API 2506

Fortinet Inc.
Post /policy/security-rule/{id}

"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-02T00:28:33.416Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2507

Fortinet Inc.
Post /policy/security-rule/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2508

Fortinet Inc.
Post /policy/security-rule/rank/set

Post /policy/security-rule/rank/set

Description

Sets the rank of the supplied Security Rule, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

rank Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

rank: 1

FortiNAC F 7.4.0 REST API 2509

Fortinet Inc.
Post /policy/security-rule/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2510

Fortinet Inc.
Post /policy/security-rule/rank/swap

Post /policy/security-rule/rank/swap

Description

Swaps the rank of the two supplied Security Rules.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Required Integer

id2 Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-

rule/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: 3

id2: 4

FortiNAC F 7.4.0 REST API 2511

Fortinet Inc.
Post /policy/security-rule/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2512

Fortinet Inc.
Post /policy/security-rule-trigger

Post /policy/security-rule-trigger

Description

Creates a new Security Trigger record, updating instead if the supplied profile has DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,
"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,

FortiNAC F 7.4.0 REST API 2513

Fortinet Inc.
Post /policy/security-rule-trigger

"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:02:06.398Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:02:06.398Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2514

Fortinet Inc.
Post /policy/security-rule-trigger

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0
}

FortiNAC F 7.4.0 REST API 2515

Fortinet Inc.
Post /policy/security-rule-trigger/{id}/delete

Post /policy/security-rule-trigger/{id}/delete

Description

Deletes a single Security Trigger record by ID.

Request Parameter

Id, the Security Trigger record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/9/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2516

Fortinet Inc.
Post /policy/security-rule-trigger/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2517

Fortinet Inc.
Post /policy/security-rule-trigger/delete

Post /policy/security-rule-trigger/delete

Description

Deletes a list of Security Trigger records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:5

FortiNAC F 7.4.0 REST API 2518

Fortinet Inc.
Post /policy/security-rule-trigger/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2519

Fortinet Inc.
Post /policy/security-rule-trigger/{id}

Post /policy/security-rule-trigger/{id}

Description

Updates a Security Trigger record.

Request Parameter

Id, the Security Trigger record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"timeLimit": 0,
"numberOfMatches": 0,
"activities": [
{
"dbid": 0,
"triggerID": 0,

FortiNAC F 7.4.0 REST API 2520

Fortinet Inc.
Post /policy/security-rule-trigger/{id}

"type": "string",
"subtype": "string",
"description": "string",
"threatID": "string",
"vendor": "string",
"occurrences": 0,
"minSeverity": 0,
"maxSeverity": 0,
"useDestination": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:02:06.398Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:02:06.398Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2521

Fortinet Inc.
Post /policy/security-rule-trigger/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2522

Fortinet Inc.
Delete /policy/security-rule-trigger/{id}

Delete /policy/security-rule-trigger/{id}

Description

Deletes a single Security Trigger record by ID.

Request Parameter

Id, the Security Trigger record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/policy/security-rule-

trigger/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2523

Fortinet Inc.
Delete /policy/security-rule-trigger/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2524

Fortinet Inc.
Delete /policy/security-rule/{id}

Delete /policy/security-rule/{id}

Description

Deletes a single Security Rule record by ID.

Request Parameter

Id, the Security Rule record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/security-rule/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2525

Fortinet Inc.
Delete /policy/security-rule/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2526

Fortinet Inc.
Self Registration

Self Registration

FortiNAC F 7.4.0 REST API 2527

Fortinet Inc.
Get /user/guest-self-registration

Get /user/guest-self-registration

Description

Returns a list of self registration request records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2528

Fortinet Inc.
Get /user/guest-self-registration

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"sponsor": "string",
"ip": "string",
"mac": "string",
"location": "string",
"guestData": "string",
"createDate": "2024-02-06T23:54:18.801Z",
"expireDate": "2024-02-06T23:54:18.801Z",
"responseDate": "2024-02-06T23:54:18.801Z",
"message": "string",
"userID": "string",
"guestDBID": 0,
"requestKey": "string",
"portalName": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:54:18.801Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"expired": true,
"pending": true,
"stateType": "ACCEPTED",
"stateDisplayValue": "string",
"formattedSponsorString": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2529

Fortinet Inc.
Get /user/guest-self-registration/count

Get /user/guest-self-registration/count

Description

Returns a count of self registration request records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2530

Fortinet Inc.
Get /user/guest-self-registration/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"sponsor": "string",
"ip": "string",
"mac": "string",
"location": "string",
"guestData": "string",
"createDate": "2024-02-06T23:54:18.801Z",
"expireDate": "2024-02-06T23:54:18.801Z",
"responseDate": "2024-02-06T23:54:18.801Z",
"message": "string",
"userID": "string",
"guestDBID": 0,
"requestKey": "string",
"portalName": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:54:18.801Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"expired": true,
"pending": true,
"stateType": "ACCEPTED",
"stateDisplayValue": "string",
"formattedSponsorString": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2531

Fortinet Inc.
Get /user/guest-self-registration/{id}/details

Get /user/guest-self-registration/{id}/details

Description

Returns the supplied guest account details for the self registration request.

Request Parameter

Id, the Security Registration record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration/1/details

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2532

Fortinet Inc.
Get /user/guest-self-registration/{id}/details

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2533

Fortinet Inc.
Get /user/guest-self-registration/count/all

Get /user/guest-self-registration/count/all

Description

Returns a count of all self registration requests in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2534

Fortinet Inc.
Get /user/guest-self-registration/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"sponsor": "string",
"ip": "string",
"mac": "string",
"location": "string",
"guestData": "string",
"createDate": "2024-02-06T23:54:18.801Z",
"expireDate": "2024-02-06T23:54:18.801Z",
"responseDate": "2024-02-06T23:54:18.801Z",
"message": "string",
"userID": "string",
"guestDBID": 0,
"requestKey": "string",
"portalName": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:54:18.801Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"expired": true,
"pending": true,
"stateType": "ACCEPTED",
"stateDisplayValue": "string",
"formattedSponsorString": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2535

Fortinet Inc.
Get /user/guest-self-registration/{id}/deny

Get /user/guest-self-registration/{id}/deny

Description

Denies a self registration request, supplying a message back to the user.

Request Parameter

Id, the Security Registration record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

guestMessage Required String

requestKey Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration/1/deny

FortiNAC F 7.4.0 REST API 2536

Fortinet Inc.
Get /user/guest-self-registration/{id}/deny

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body guestMessage: "xxxxxxxxxxxx"

requestKey: "xxxxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2537

Fortinet Inc.
Get /user/guest-self-registration/{id}

Get /user/guest-self-registration/{id}

Description

Returns a list of self registration request records matching the supplied database id.

Request Parameter

Id, the Security Registration record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/guest-self-

registration/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2538

Fortinet Inc.
Get /user/guest-self-registration/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"sponsor": "string",
"ip": "string",
"mac": "string",
"location": "string",
"guestData": "string",
"createDate": "2024-02-06T23:54:18.801Z",
"expireDate": "2024-02-06T23:54:18.801Z",
"responseDate": "2024-02-06T23:54:18.801Z",
"message": "string",
"userID": "string",
"guestDBID": 0,
"requestKey": "string",
"portalName": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-06T23:54:18.801Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"expired": true,
"pending": true,
"stateType": "ACCEPTED",
"stateDisplayValue": "string",
"formattedSponsorString": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2539

Fortinet Inc.
Post /user/guest-self-registration/{id}/approve

Post /user/guest-self-registration/{id}/approve

Description

Approves a self registration request, supplying a message back to the user.

Request Parameter

Id, the Security Registration record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

guestMessage Required String

requestKey Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/guest-self-

registration/1/approve

FortiNAC F 7.4.0 REST API 2540

Fortinet Inc.
Post /user/guest-self-registration/{id}/approve

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body guestMessage: "xxxxxxxxxxxx"

requestKey: "xxxxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2541

Fortinet Inc.
Server Management

Server Management

FortiNAC F 7.4.0 REST API 2542

Fortinet Inc.
Get /system/properties/license

Get /system/properties/license

Description

Returns the current license information for this server and all managed server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/properties/license

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2543

Fortinet Inc.
Get /system/properties/license

Sample Response

{
"status": "string",
"errorMessage": "string",
"totalCount": 0,
"availableCount": 0,
"inUseCount": 0,
"results": [
{
"name": "string",
"usagePercent": 0,
"usage": 0,
"host": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2544

Fortinet Inc.
Get /system/properties/hardware

Get /system/properties/hardware

Description

Queries hardware status and performance informaiton.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/properties/hardware

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2545

Fortinet Inc.
Get /system/properties/hardware

Sample Response

{
"status": "success",
"errorMessage": null,
"swapUsed": 28,
"memoryFree": "5.6 GB",
"diskUsage": [
{
"name": "/data",
"free": "1.9 GB",
"total": "1.9 GB",
"usage": 0
},
{
"name": "/storage",
"free": "97.3 GB",
"total": "97.9 GB",
"usage": 0
}
],
"memorySwapUsed": null,
"loaders": [
{
"name": "Principal",
"numberOfThreads": "434",
"memoryTotal": "3.8 GB",
"memoryFree": "3.6 GB",
"memoryUsed": "4"
},
{
"name": "Nessus",
"numberOfThreads": "63",
"memoryTotal": "1.0 GB",
"memoryFree": "951.5 MB",
"memoryUsed": "10"
}
],
"upTime": "2 Days 20 Hours 45 Minutes 56 Seconds ",
"swapFree": "5.6 GB",
"memorySwapTotal": null,
"memoryTotal": "7.8 GB",
"swapTotal": "7.8 GB",
"startTime": "Sun Feb 04 21:29:10 EST 2024",
"memorySwapFree": null,
"memoryUsed": 28,
"cpuUsage": "0"
}

FortiNAC F 7.4.0 REST API 2546

Fortinet Inc.
Get /system/managed-server/{id}/properties

Get /system/managed-server/{id}/properties

Description

Returns additional properties about a server that have been set in the manager.

Request Parameter

Id, the managed server id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/managed-

server/1/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2547

Fortinet Inc.
Get /system/managed-server/{id}/properties

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
"Customer Domain",
"Customer"
]
}

FortiNAC F 7.4.0 REST API 2548

Fortinet Inc.
Get /system/managed-server/summary

Get /system/managed-server/summary

Description

Returns the cluster information for all managed servers, listing Control/Application pairs and High Availability servers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/managed-

server/summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2549

Fortinet Inc.
Get /system/managed-server/summary

Sample Response

{
"status": "string",
"errorMessage": "string",
"clusters": [
{
"primaryServer": {
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
},
"secondaryServer": {
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
},
"appServers": [
{
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
}
]
}
]
}

FortiNAC F 7.4.0 REST API 2550

Fortinet Inc.
Get /system/managed-server/{id}/scans

Get /system/managed-server/{id}/scans

Description

Returns all scan configurations available on the requested managed server.

Request Parameter

Id, the managed server id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/managed-

server/1/scans

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2551

Fortinet Inc.
Get /system/managed-server/{id}/scans

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2552

Fortinet Inc.
Get /system/managed-server/filtered-summary

Get /system/managed-server/filtered-summary

Description

Return the cluster information for all managed servers using the given sort and filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

sortKey Optional String

sortDir Optional String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/system/managed-

server/filtered-summary

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body sortKey: "xxxxxxxxxx'

sortDir: "asc"

FortiNAC F 7.4.0 REST API 2553

Fortinet Inc.
Get /system/managed-server/filtered-summary

Sample Response

{
"status": "string",
"errorMessage": "string",
"clusters": [
{
"primaryServer": {
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
},
"secondaryServer": {
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
},
"appServers": [
{
"id": 0,
"name": "string",
"ip": "string",
"lastSyncAttempt": 0,
"lastSyncSuccess": 0,
"status": "string",
"product": "string"
}
]
}
]
}

FortiNAC F 7.4.0 REST API 2554

Fortinet Inc.
Post /system/managed-server

Post /system/managed-server

Description

Adds a new server to be managed by this server. Managed servers will receive configuration from this server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ip Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/managed-server

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip: "xx.xx.xx.xxx"

FortiNAC F 7.4.0 REST API 2555

Fortinet Inc.
Post /system/managed-server

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2556

Fortinet Inc.
Post /system/managed-server/delete

Post /system/managed-server/delete

Description

Removes a server from management. The server will no longer receive configuration changes and will be able to
manage all locally defined configurations.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/managed-

server/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: xx

FortiNAC F 7.4.0 REST API 2557

Fortinet Inc.
Post /system/managed-server/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2558

Fortinet Inc.
Post /system/managed-server/{id}/properties

Post /system/managed-server/{id}/properties

Description

Sets additional properties about a server in the manager.

Request Parameter

Id, the managed server id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

ip Required String

name Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/managed-

server/1/properties

FortiNAC F 7.4.0 REST API 2559

Fortinet Inc.
Post /system/managed-server/{id}/properties

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body ip: "xx.xx.xx.xxx"

name: "xxxxxxxxxx"

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2560

Fortinet Inc.
Post /system/managed-server/sync

Post /system/managed-server/sync

Description

Synchronizes data from the management server to the managed server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

serverIP Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/managed-

server/sync

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body serverIP: "xxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2561

Fortinet Inc.
Post /system/managed-server/sync

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2562

Fortinet Inc.
Post /system/managed-server/ping

Post /system/managed-server/ping

Description

Get server data from a POD managed server from the management server.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

address Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/managed-

server/ping

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body address: "xxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2563

Fortinet Inc.
Post /system/managed-server/ping

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2564

Fortinet Inc.
Service Connector

Service Connector

FortiNAC F 7.4.0 REST API 2565

Fortinet Inc.
Get /system/service-connector

Get /system/service-connector

Description

Returns a summary of all configured Service Connectors.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/service-connector

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2566

Fortinet Inc.
Get /system/service-connector

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"id": 0,
"name": "string",
"type": "GOOGLE_AUTH",
"count": 0,
"details": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"status": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2567

Fortinet Inc.
SMS Provider

SMS Provider

FortiNAC F 7.4.0 REST API 2568

Fortinet Inc.
Get /settings/integration/sms/count

Get /settings/integration/sms/count

Description

Returns a count of SMS Provider records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/sms/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2569

Fortinet Inc.
Get /settings/integration/sms/count

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"providerName": "string",
"emailToSMS": "string",
"country": "string",
"state": "string",
"enabled": true,
"version": 0,
"maxMessageLength": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2570

Fortinet Inc.
Get /settings/integration/sms

Get /settings/integration/sms

Description

Returns all SMS Provider records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/sms

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2571

Fortinet Inc.
Get /settings/integration/sms

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": 193,
"total": 193
}

FortiNAC F 7.4.0 REST API 2572

Fortinet Inc.
Get /settings/integration/sms/count/all

Get /settings/integration/sms/count/all

Description

Returns the count of all SMS Provider records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/sms/count/all

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2573

Fortinet Inc.
Get /settings/integration/sms/count/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"providerName": "string",
"emailToSMS": "string",
"country": "string",
"state": "string",
"enabled": true,
"version": 0,
"maxMessageLength": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2574

Fortinet Inc.
Get /settings/integration/sms/global/max-length

Get /settings/integration/sms/global/max-length

Description

Gets the maximum length of SMS messages for all providers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/settings/integration/sms/global/max-

URL length

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2575

Fortinet Inc.
Get /settings/integration/sms/global/max-length

Sample Response

{
"status": "success",
"errorMessage": null,
"result": 0
}

FortiNAC F 7.4.0 REST API 2576

Fortinet Inc.
Get /settings/integration/sms/{id}

Get /settings/integration/sms/{id}

Description

Returns the SMS Provider record with the supplied DBID.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/sm/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2577

Fortinet Inc.
Get /settings/integration/sms/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": -1,
"id": 3,
"providerName": "AirVoice",
"emailToSMS": "[email protected]",
"country": "United States",
"state": 0,
"enabled": false,
"version": 1.0,
"maxMessageLength": -1
}
],
"filtered": 1,
"total": 193
}

FortiNAC F 7.4.0 REST API 2578

Fortinet Inc.
Get /settings/integration/sms/{id}/usage

Get /settings/integration/sms/{id}/usage

Description

Returns a list of records that reference this SMS Provider record.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/sms/6/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2579

Fortinet Inc.
Get /settings/integration/sms/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2580

Fortinet Inc.
Post /settings/agent/status-notifications

Post /settings/agent/status-notifications

Description

Configures status notifications for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/status-

notifications

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"attrNames": [
"string"
],
"attrValues": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2581

Fortinet Inc.
Post /settings/agent/status-notifications

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2582

Fortinet Inc.
Post /settings/integration/sms/global/max-length

Post /settings/integration/sms/global/max-length

Description

Sets the maximum length of SMS messages for all providers.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

maxLength Required Integer

Sample Request

Request POST https://10.106.94.152:8443/api/v2/settings/integration/sms/global/max-

URL length

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request maxLength: 100

Body

FortiNAC F 7.4.0 REST API 2583

Fortinet Inc.
Post /settings/integration/sms/global/max-length

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2584

Fortinet Inc.
Post /settings/integration/sms

Post /settings/integration/sms

Description

Adds a new SMS Provider record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"providerName": "string",
"emailToSMS": "string",
"country": "string",
"state": "string",
"enabled": true,
"version": 0,
"maxMessageLength": 0
}

FortiNAC F 7.4.0 REST API 2585

Fortinet Inc.
Post /settings/integration/sms

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2586

Fortinet Inc.
Post /settings/integration/sms/{id}

Post /settings/integration/sms/{id}

Description

Updates an existing SMS Provider record in the database.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"providerName": "string",
"emailToSMS": "string",
"country": "string",
"state": "string",
"enabled": true,
"version": 0,

FortiNAC F 7.4.0 REST API 2587

Fortinet Inc.
Post /settings/integration/sms/{id}

"maxMessageLength": 0
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2588

Fortinet Inc.
Post /settings/integration/sms/delete

Post /settings/integration/sms/delete

Description

Deletes the SMS Provider record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 3

FortiNAC F 7.4.0 REST API 2589

Fortinet Inc.
Post /settings/integration/sms/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2590

Fortinet Inc.
Post /settings/integration/sms/{id}/disable

Post /settings/integration/sms/{id}/disable

Description

Disables the supplied SMS Provider.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms/4/disable

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2591

Fortinet Inc.
Post /settings/integration/sms/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2592

Fortinet Inc.
Post /settings/integration/sms/{id}/enable

Post /settings/integration/sms/{id}/enable

Description

Enables the supplied SMS Provider.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms/4/enable

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2593

Fortinet Inc.
Post /settings/integration/sms/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2594

Fortinet Inc.
Post /settings/integration/sms/{id}/delete

Post /settings/integration/sms/{id}/delete

Description

Deletes the SMS Provider record supplied, if they are not currently in use.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/sms/6/delete

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2595

Fortinet Inc.
Post /settings/integration/sms/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2596

Fortinet Inc.
Delete /settings/integration/sms/{id}

Delete /settings/integration/sms/{id}

Description

Deletes the SMS Provider record supplied, if it is not currently in use.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/sms/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2597

Fortinet Inc.
Delete /settings/integration/sms/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2598

Fortinet Inc.
Status Notifications

Status Notifications

FortiNAC F 7.4.0 REST API 2599

Fortinet Inc.
Get /settings/agent/status-notifications

Get /settings/agent/status-notifications

Description

Returns all the status notifications for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/agent/status-

notifications

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2600

Fortinet Inc.
Get /settings/agent/status-notifications

Sample Response

{
"status": "success",
"errorMessage": null,
"result": {
"DISABLED": {
"iconEnabled": "",
"balloonText": "",
"balloonEnabled": ""
},
"LOGGED_ON": {
"iconEnabled": "",
"balloonText": "",
"balloonEnabled": ""
},
"PENDING_AT_RISK": {
"iconEnabled": "",
"balloonText": "",
"balloonEnabled": ""
},
"DISCONNECTED": {
"iconEnabled": "",
"balloonText": "",
"balloonEnabled": ""
}
}
}

FortiNAC F 7.4.0 REST API 2601

Fortinet Inc.
Post /settings/agent/status-notifications

Post /settings/agent/status-notifications

Description

Configures the status notifications for the Persistent Agent.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/status-

notifications

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"attrNames": [
"string"
],
"attrValues": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2602

Fortinet Inc.
Post /settings/agent/status-notifications

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2603

Fortinet Inc.
Supplicant Policy

Supplicant Policy

FortiNAC F 7.4.0 REST API 2604

Fortinet Inc.
Get /policy/supplicant

Get /policy/supplicant

Description

Returns a list of Supplicant Policy records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2605

Fortinet Inc.
Get /policy/supplicant

Sample Response

FortiNAC F 7.4.0 REST API 2606

Fortinet Inc.
Get /policy/supplicant

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:01:40.237Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:01:40.237Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-09T00:01:40.237Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
FortiNAC F 7.4.0 REST API"additionalProp3": "string" 2607
Fortinet Inc. }
}
],
Get /policy/supplicant/{id}

Get /policy/supplicant/{id}

Description

Returns a list of Supplicant Policy records matching the supplied filter.

Request Parameter

Id, the Supplicant policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2608

Fortinet Inc.
Get /policy/supplicant/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2609

Fortinet Inc.
Get /policy/supplicant/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:01:40.237Z",
"name": "string",
"note": "string",
"profile": {
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:01:40.237Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-09T00:01:40.237Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
FortiNAC F 7.4.0 REST API"additionalProp3": "string" 2610
Fortinet Inc. }
}
],
Get /policy/supplicant-configuration/{id}

Get /policy/supplicant-configuration/{id}

Description

Returns a list of Supplicant Configuration records matching the supplied filter.

Request Parameter

Id, the Supplicant Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2611

Fortinet Inc.
Get /policy/supplicant-configuration/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-08T22:53:15.130Z",
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"password": "string",
"certificate": "string",
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-08T22:53:15.130Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2612

Fortinet Inc.
Get /policy/supplicant-configuration

Get /policy/supplicant-configuration

Description

Returns a list of Supplicant Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2613

Fortinet Inc.
Get /policy/supplicant-configuration

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-08T22:53:15.130Z",
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"password": "string",
"certificate": "string",
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-08T22:53:15.130Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2614

Fortinet Inc.
Get /policy/supplicant-configuration/{id}/usage

Get /policy/supplicant-configuration/{id}/usage

Description

Returns a list of Supplicant Configuration records that reference this recrod.

Request Parameter

Id, the Supplicant Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/2/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2615

Fortinet Inc.
Get /policy/supplicant-configuration/{id}/usage

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2616

Fortinet Inc.
Get /policy/supplicant-configuration/supporting-info

Get /policy/supplicant-configuration/supporting-info

Description

Returns the information necessary to create a Supplicant Configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2617

Fortinet Inc.
Get /policy/supplicant-configuration/supporting-info

Sample Response

FortiNAC F 7.4.0 REST API 2618

Fortinet Inc.
Get /policy/supplicant-configuration/supporting-info

{
"status": "success",
"errorMessage": null,
"cipher": [
"AES",
"NONE",
"TKIP"
],
"security": [
{
"displayString": "Open",
"eapString": "OPEN",
"passwordRequired": false,
"eapRequired": false
},
{
"displayString": "WEP",
"eapString": "WEP",
"passwordRequired": true,
"eapRequired": false
},
{
"displayString": "WEP Enterprise",
"eapString": "WEP_ENTERPRISE",
"passwordRequired": true,
"eapRequired": true
},
{
"displayString": "WPA",
"eapString": "WPA",
"passwordRequired": true,
"eapRequired": false
},
{
"displayString": "WPA2",
"eapString": "WPA2",
"passwordRequired": true,
"eapRequired": false
},
{
"displayString": "WPA Enterprise",
"eapString": "WPA_ENTERPRISE",
"passwordRequired": false,
"eapRequired": true
},
{
"displayString": "WPA2 Enterprise",
"eapString": "WPA2_ENTERPRISE",
"passwordRequired": false,
"eapRequired": true
}
],
"eapType": {
"PEAP": "PEAP"
}
}

FortiNAC F 7.4.0 REST API 2619

Fortinet Inc.
Get /policy/supplicant/supporting-info

Get /policy/supplicant/supporting-info

Description

Returns the information used to create a Supplicant Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/supplicant/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2620

Fortinet Inc.
Get /policy/supplicant/supporting-info

Sample Response

FortiNAC F 7.4.0 REST API 2621

Fortinet Inc.
Get /policy/supplicant/supporting-info

{
"status": "string",
"errorMessage": "string",
"accessProfiles": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-13T01:09:24.675Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-13T01:09:24.675Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
FortiNAC F 7.4.0 "string"
REST API 2622
Fortinet Inc. ]
}
],
Post /policy/supplicant

Post /policy/supplicant

Description

Creates a new Supplicant Policy record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:09:49.774Z",
"name": "string",
"note": "string",
"profile": {
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-09T00:09:49.774Z",
"groupIDs": [
0
],

FortiNAC F 7.4.0 REST API 2623

Fortinet Inc.
Post /policy/supplicant

"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
},
"configuration": {
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"security": "string",

FortiNAC F 7.4.0 REST API 2624

Fortinet Inc.
Post /policy/supplicant

"cipher": "string",
"password": "string",
"certificate": "string",
"badSSIDNames": [
{
"dbid": 0,
"parent": "string",
"value": "string"
}
],
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-09T00:09:49.774Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0,
"eapType": "string"
},
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-09T00:09:49.774Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"

FortiNAC F 7.4.0 REST API 2625

Fortinet Inc.
Post /policy/supplicant

},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"configurationName": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2626

Fortinet Inc.
Post /policy/supplicant/delete

Post /policy/supplicant/delete

Description

Deletes a list of Supplicant Policy records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

FortiNAC F 7.4.0 REST API 2627

Fortinet Inc.
Post /policy/supplicant/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2628

Fortinet Inc.
Post /policy/supplicant/disable

Post /policy/supplicant/disable

Description

Disables the supplied Supplicant Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

FortiNAC F 7.4.0 REST API 2629

Fortinet Inc.
Post /policy/supplicant/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2630

Fortinet Inc.
Post /policy/supplicant/enable

Post /policy/supplicant/enable

Description

Enables the supplied Supplicant Policy.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

FortiNAC F 7.4.0 REST API 2631

Fortinet Inc.
Post /policy/supplicant/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2632

Fortinet Inc.
Post /policy/supplicant/{id}

Post /policy/supplicant/{id}

Description

Updates an Supplicant Policy record.

Request Parameter

Id, the Supplicant Policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"rank": 0,
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-09T00:09:49.774Z",
"name": "string",
"note": "string",
"profile": {

FortiNAC F 7.4.0 REST API 2633

Fortinet Inc.
Post /policy/supplicant/{id}

"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-09T00:09:49.774Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]

FortiNAC F 7.4.0 REST API 2634

Fortinet Inc.
Post /policy/supplicant/{id}

},
"configuration": {
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"security": "string",
"cipher": "string",
"password": "string",
"certificate": "string",
"badSSIDNames": [
{
"dbid": 0,
"parent": "string",
"value": "string"
}
],
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-09T00:09:49.774Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0,
"eapType": "string"
},
"enabled": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-09T00:09:49.774Z",

FortiNAC F 7.4.0 REST API 2635

Fortinet Inc.
Post /policy/supplicant/{id}

"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"configurationName": "string"
}

FortiNAC F 7.4.0 REST API 2636

Fortinet Inc.
Post /policy/supplicant/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2637

Fortinet Inc.
Post /policy/supplicant/{id}/delete

Post /policy/supplicant/{id}/delete

Description

Deletes a single Supplicant Policy record by ID.

Request Parameter

Id, the Supplicant Policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/1/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2638

Fortinet Inc.
Post /policy/supplicant/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2639

Fortinet Inc.
Post /policy/supplicant/{id}/disable

Post /policy/supplicant/{id}/disable

Description

Disables the supplied Supplicant Policy.

Request Parameter

Id, the Supplicant Policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/1/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2640

Fortinet Inc.
Post /policy/supplicant/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2641

Fortinet Inc.
Post /policy/supplicant/{id}/enable

Post /policy/supplicant/{id}/enable

Description

Enables the supplied Supplicant Policy.

Request Parameter

Id, the Supplicant Policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/1/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2642

Fortinet Inc.
Post /policy/supplicant/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2643

Fortinet Inc.
Post /policy/supplicant/rank/set

Post /policy/supplicant/rank/set

Description

Sets the rank of the supplied Supplicant Policy, shifting other ranks as necessary.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

rank Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/rank/set

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 1

rank: 2

FortiNAC F 7.4.0 REST API 2644

Fortinet Inc.
Post /policy/supplicant/rank/set

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2645

Fortinet Inc.
Post /policy/supplicant-configuration

Post /policy/supplicant-configuration

Description

Creates a new Supplicant Configuration record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"security": "string",
"cipher": "string",
"password": "string",
"certificate": "string",
"badSSIDNames": [
{
"dbid": 0,
"parent": "string",
"value": "string"

FortiNAC F 7.4.0 REST API 2646

Fortinet Inc.
Post /policy/supplicant-configuration

}
],
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-08T22:57:39.781Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0,
"eapType": "string"
}

FortiNAC F 7.4.0 REST API 2647

Fortinet Inc.
Post /policy/supplicant-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2648

Fortinet Inc.
Post /policy/supplicant-configuration/delete

Post /policy/supplicant-configuration/delete

Description

Deletes a list of Supplicant Configuration records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 2649

Fortinet Inc.
Post /policy/supplicant-configuration/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2650

Fortinet Inc.
Post /policy/supplicant-configuration/{id}

Post /policy/supplicant-configuration/{id}

Description

Updates an Supplicant Configuration record.

Request Parameter

Id, the Supplicant Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"name": "string",
"note": "string",
"ssid": "string",
"bssid": "string",
"hidden": true,
"security": "string",
"cipher": "string",
"password": "string",

FortiNAC F 7.4.0 REST API 2651

Fortinet Inc.
Post /policy/supplicant-configuration/{id}

"certificate": "string",
"badSSIDNames": [
{
"dbid": 0,
"parent": "string",
"value": "string"
}
],
"validateServerCertWindows": true,
"eapconfig": "TLS",
"configCipher": "AES",
"badSSIDNameSet": [
"string"
],
"cafingerprint": "string",
"securityType": "OPEN",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-08T22:57:39.781Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"id": 0,
"eapType": "string"
}

FortiNAC F 7.4.0 REST API 2652

Fortinet Inc.
Post /policy/supplicant-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2653

Fortinet Inc.
Post /policy/supplicant-configuration/{id}/delete

Post /policy/supplicant-configuration/{id}/delete

Description

Deletes a single Supplicant Configuration record by ID.

Request Parameter

Id, the SMS Provider record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/5/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2654

Fortinet Inc.
Post /policy/supplicant-configuration/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2655

Fortinet Inc.
Post /policy/supplicant/rank/swap

Post /policy/supplicant/rank/swap

Description

Swaps the rank position of the two supplied Supplicant Policies.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id1 Required Integer

id2 Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/supplicant/rank/swap

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id1: xx

id2: xx

FortiNAC F 7.4.0 REST API 2656

Fortinet Inc.
Post /policy/supplicant/rank/swap

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2657

Fortinet Inc.
Delete /policy/supplicant/{id}

Delete /policy/supplicant/{id}

Description

Deletes a single Supplicant Policy record by ID.

Request Parameter

Id, the Supplicant Policy record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/supplicant/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2658

Fortinet Inc.
Delete /policy/supplicant/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2659

Fortinet Inc.
Delete /policy/supplicant-configuration/{id}

Delete /policy/supplicant-configuration/{id}

Description

Deletes a single Supplicant Configuration record by ID.

Request Parameter

Id, the Supplicant Configuration record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Delete https://10.106.94.152:8443/api/v2/policy/supplicant-

configuration/5

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2660

Fortinet Inc.
Delete /policy/supplicant-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2661

Fortinet Inc.
Syslog

Syslog

FortiNAC F 7.4.0 REST API 2662

Fortinet Inc.
Get /settings/integration/syslog/{id}

Get /settings/integration/syslog/{id}

Description

Returns a list of syslog parser records matching the supplied filter.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2663

Fortinet Inc.
Get /settings/integration/syslog/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2664

Fortinet Inc.
Get /settings/integration/syslog/{id}

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"isRTR": false,
"isEnabled": true,
"name": "StoneGate IPS",
"vendor": "StoneGate",
"format": 1,
"delimiter": ",",
"tagDelimiter": "=",
"sourceIPColumn": "5",
"sourceIPMatcher": ".*",
"sourceIPValue": "$0",
"destinationIPColumn": "",
"destinationIPMatcher": ".*",
"destinationIPValue": "$0",
"typeColumn": "2",
"typeMatcher": ".*",
"typeValue": "Permit,Denied,Terminate,Default alert",
"subtypeColumn": "",
"subtypeMatcher": ".*",
"subtypeValue": "$0",
"threatIDColumn": "",
"threatIDMatcher": ".*",
"threatIDValue": "$0",
"descriptionColumn": "6,3,7,2,8",
"descriptionMatcher": ".*",
"descriptionValue": "{0}, Severity {1}\nRuleID {2}, Action
{3}\nProtocol {4}.",
"severityColumn": "3",
"severityMatcher": ".*",
"severityValue": "$0",
"severityMap": {
"10": 3,
"1": 1,
"2": 1,
"3": 1,
"4": 2,
"5": 2,
"6": 2,
"7": 3,
"8": 3,
"9": 3
},
"yamsEventTag": null,
"auditObj": null,
"auditObjectName": "StoneGate IPS",
"auditObjectType": {
"auditTableName": "RTRSecurityEventParserAudit",
"mysqlTableName": "RTRSecurityEventParser",
"idnameQuery": "select ID,name from RTRSecurityEventParser where
ID in"
},
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:28.000+0000"
}
],
FortiNAC F 7.4.0 REST
"filtered": 1,API 2665
Fortinet Inc.
"total": 1
}
Get /settings/integration/syslog/{id}/usage

Get /settings/integration/syslog/{id}/usage

Description

Returns a list of record that reference this syslog parser record.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Reques GET https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1/usage

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header

FortiNAC F 7.4.0 REST API 2666

Fortinet Inc.
Get /settings/integration/syslog/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"return": []
}

FortiNAC F 7.4.0 REST API 2667

Fortinet Inc.
Get /settings/integration/syslog

Get /settings/integration/syslog

Description

Returns a list of syslog parser records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2668

Fortinet Inc.
Get /settings/integration/syslog

Sample Response

FortiNAC F 7.4.0 REST API 2669

Fortinet Inc.
Get /settings/integration/syslog

{
"status": "success",
"errorMessage": null,
"results": [
{
"dbid": 1,
"isRTR": false,
"isEnabled": true,
"name": "StoneGate IPS",
"vendor": "StoneGate",
"format": 1,
"delimiter": ",",
"tagDelimiter": "=",
"sourceIPColumn": "5",
"sourceIPMatcher": ".*",
"sourceIPValue": "$0",
"destinationIPColumn": "",
"destinationIPMatcher": ".*",
"destinationIPValue": "$0",
"typeColumn": "2",
"typeMatcher": ".*",
"typeValue": "Permit,Denied,Terminate,Default alert",
"subtypeColumn": "",
"subtypeMatcher": ".*",
"subtypeValue": "$0",
"threatIDColumn": "",
"threatIDMatcher": ".*",
"threatIDValue": "$0",
"descriptionColumn": "6,3,7,2,8",
"descriptionMatcher": ".*",
"descriptionValue": "{0}, Severity {1}\nRuleID {2}, Action
{3}\nProtocol {4}.",
"severityColumn": "3",
"severityMatcher": ".*",
"severityValue": "$0",
"severityMap": {
"10": 3,
"1": 1,
"2": 1,
"3": 1,
"4": 2,
"5": 2,
"6": 2,
"7": 3,
"8": 3,
"9": 3
},
"yamsEventTag": null,
"auditObj": null,
"auditObjectName": "StoneGate IPS",
"auditObjectType": {
"auditTableName": "RTRSecurityEventParserAudit",
"mysqlTableName": "RTRSecurityEventParser",
"idnameQuery": "select ID,name from RTRSecurityEventParser where
ID in"
},
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:28.000+0000"
}
],
FortiNAC F 7.4.0 REST
"filtered": 1,API 2670
Fortinet Inc.
"total": 1
}
Post /settings/integration/syslog/delete

Post /settings/integration/syslog/delete

Description

Deletes a list of syslog parser records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array

Sample Request

Reques POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/delete

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header
Reques Id:6
t Body

FortiNAC F 7.4.0 REST API 2671

Fortinet Inc.
Post /settings/integration/syslog/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2672

Fortinet Inc.
Post /settings/integration/syslog/{id}

Post /settings/integration/syslog/{id}

Description

Updates an syslog parser record.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request {
Body "dbid": 0,
"isRTR": true,
"isEnabled": true,
"name": "string",
"vendor": "string",
"format": 0,
"delimiter": "string",

FortiNAC F 7.4.0 REST API 2673

Fortinet Inc.
Post /settings/integration/syslog/{id}

"tagDelimiter": "string",
"sourceIPColumn": "string",
"sourceIPMatcher": "string",
"sourceIPValue": "string",
"destinationIPColumn": "string",
"destinationIPMatcher": "string",
"destinationIPValue": "string",
"typeColumn": "string",
"typeMatcher": "string",
"typeValue": "string",
"subtypeColumn": "string",
"subtypeMatcher": "string",
"subtypeValue": "string",
"threatIDColumn": "string",
"threatIDMatcher": "string",
"threatIDValue": "string",
"descriptionColumn": "string",
"descriptionMatcher": "string",
"descriptionValue": "string",
"severityColumn": "string",
"severityMatcher": "string",
"severityValue": "string",
"severityMap": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-13T18:15:58.939Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2674

Fortinet Inc.
Post /settings/integration/syslog/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2675

Fortinet Inc.
Post /settings/integration/syslog

Post /settings/integration/syslog

Description

Creates a new syslog parser record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request {
Body "dbid": 0,
"isRTR": true,
"isEnabled": true,
"name": "string",
"vendor": "string",
"format": 0,
"delimiter": "string",
"tagDelimiter": "string",
"sourceIPColumn": "string",
"sourceIPMatcher": "string",
"sourceIPValue": "string",
"destinationIPColumn": "string",
"destinationIPMatcher": "string",
"destinationIPValue": "string",
"typeColumn": "string",
"typeMatcher": "string",

FortiNAC F 7.4.0 REST API 2676

Fortinet Inc.
Post /settings/integration/syslog

"typeValue": "string",
"subtypeColumn": "string",
"subtypeMatcher": "string",
"subtypeValue": "string",
"threatIDColumn": "string",
"threatIDMatcher": "string",
"threatIDValue": "string",
"descriptionColumn": "string",
"descriptionMatcher": "string",
"descriptionValue": "string",
"severityColumn": "string",
"severityMatcher": "string",
"severityValue": "string",
"severityMap": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-13T18:15:58.939Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
}
}

FortiNAC F 7.4.0 REST API 2677

Fortinet Inc.
Post /settings/integration/syslog

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2678

Fortinet Inc.
Post /settings/integration/syslog/{id}/disable

Post /settings/integration/syslog/{id}/disable

Description

Disables the syslog parser, allowing it to process Syslog messages.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Reques POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1/disable

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header

FortiNAC F 7.4.0 REST API 2679

Fortinet Inc.
Post /settings/integration/syslog/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2680

Fortinet Inc.
Post /settings/integration/syslog/{id}/enable

Post /settings/integration/syslog/{id}/enable

Description

Enable the single syslog parser, allowing it to process Syslog messages.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Reques POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1/enable

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header

FortiNAC F 7.4.0 REST API 2681

Fortinet Inc.
Post /settings/integration/syslog/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2682

Fortinet Inc.
Post /settings/integration/syslog/{id}/delete

Post /settings/integration/syslog/{id}/delete

Description

Deletes a single syslog parser record by ID.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Reques POST https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/6/delete

t URL
Reques Authorization: Bearer <Authorization_Token>
t Content-Type: application/json
Header

FortiNAC F 7.4.0 REST API 2683

Fortinet Inc.
Post /settings/integration/syslog/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2684

Fortinet Inc.
Delete /settings/integration/syslog/{id}

Delete /settings/integration/syslog/{id}

Description

Deletes a single syslog parser record by ID.

Request Parameter

Id, the syslog parser record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request DELETE https://10.106.94.152:8443/api/v2/policy/settings/integration/syslog/1

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2685

Fortinet Inc.
Delete /settings/integration/syslog/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2686

Fortinet Inc.
System

System

FortiNAC F 7.4.0 REST API 2687

Fortinet Inc.
Get /system/debug/log

Get /system/debug/log

Description

Returns the requested number of lines from the tail of one of the log files on the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

logName Required String

tailLog Required Boolean

lastKnownLogLength Required Integer

LogLines Required String

hostName Required String

filter Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/log

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2688

Fortinet Inc.
Get /system/debug/log

Content-Type: application/json

Request Body logName: "xxxxxxxxx"

tailLog: True
lastKnownLogLength: xxxxxxxxx
LogLines: "xxxxxxxxx"
hostName: "xxxxxxxxx"
filter: "xxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string",
"linesReturned": 0,
"logLength": 0,
"logOutput": "string"
}

FortiNAC F 7.4.0 REST API 2689

Fortinet Inc.
Get /system/debug/database/relations

Get /system/debug/database/relations

Description

Queries the relations table, a polymorphic associative table between various other tables.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

relType Required String($byte)

leftType Required String($byte)

rightType Required String($byte)

leftID Required String($byte)

rightID Required String($byte)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/database/relations

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2690

Fortinet Inc.
Get /system/debug/database/relations

Request Body relType: xxxxxxxxx

leftType: xxxxxxxxx
rightType: xxxxxxxxx
leftID: xxxxxxxxx
rightID: xxxxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"state": "string",
"type": "string",
"leftType": "string",
"rightType": "string",
"version": 0,
"leftID": 0,
"rightID": 0
}
]
}

FortiNAC F 7.4.0 REST API 2691

Fortinet Inc.
Get /system/debug/database/tables

Get /system/debug/database/tables

Description

Returns a summary of all tables in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/database/tables

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2692

Fortinet Inc.
Get /system/debug/database/tables

Sample Response

{
"status": "string",
"errorMessage": "string",
"tableSummary": {
"jsonString": "string",
"size": 0,
"dataString": "string"
}
}

FortiNAC F 7.4.0 REST API 2693

Fortinet Inc.
Get /system/debug/database/table/data

Get /system/debug/database/table/data

Description

Queries the table and returns the results of the query as a JSON array.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

countOnly Optional Boolean

name Optional String

filters Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/database/table/data

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body filters: "xxxxxxx"

FortiNAC F 7.4.0 REST API 2694

Fortinet Inc.
Get /system/debug/database/table/data

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{}
]
}

FortiNAC F 7.4.0 REST API 2695

Fortinet Inc.
Get /system/debug/elements

Get /system/debug/elements

Description

Returns Name/ID pairs of the elements of a given type. Allowed types are host, adapter, user, and device.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

type Required String

id Required Integer

name Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/elements

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body type: xxxxxx

id: xx
name: xxxxxx

FortiNAC F 7.4.0 REST API 2696

Fortinet Inc.
Get /system/debug/elements

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2697

Fortinet Inc.
Get /system/debug/elements/attributes

Get /system/debug/elements/attributes

Description

Returns attributes stored by the system on the elements of a given type and DBID. Allowed types are host, adapter,
user, device, and nselem.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

type Required String

id Required Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/elements/attributes

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body type: host

id: 1

FortiNAC F 7.4.0 REST API 2698

Fortinet Inc.
Get /system/debug/elements/attributes

Sample Response

{
"status": "string",
"errorMessage": "string",
"name": "string",
"id": 0,
"results": [
{
"version": 0,
"name": "string",
"value": {}
}
]
}

FortiNAC F 7.4.0 REST API 2699

Fortinet Inc.
Get /system/debug/grabLogSnapshot-download

Get /system/debug/grabLogSnapshot-download

Description

Download the gran log snapshot file.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

String (Default
hostName Required
value: )

String (Default
type Required
value: zip)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/grabLogSnapshot-

download

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body hostName:"xxxxxxxx"

type:"zip"

FortiNAC F 7.4.0 REST API 2700

Fortinet Inc.
Get /system/debug/grabLogSnapshot-download

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2701

Fortinet Inc.
Get /system/debug/grabLogSnapshot-status

Get /system/debug/grabLogSnapshot-status

Description

Returns the status of an ongoing grab log snapshot collection.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

String (Default
hostName Required
value: )

String (Default
type Required
value: zip)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/grabLogSnapshot-

status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body hostName:"xxxxxxxxxxx"

type:"zip"

FortiNAC F 7.4.0 REST API 2702

Fortinet Inc.
Get /system/debug/grabLogSnapshot-status

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "0",
"state": "NOT_FOUND"
}

FortiNAC F 7.4.0 REST API 2703

Fortinet Inc.
Get /system/debug/gui/experiments

Get /system/debug/gui/experiments

Description

Returns if the GUI is currently configured to display any experimental or early development features.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/gui/experiments

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2704

Fortinet Inc.
Get /system/debug/gui/experiments

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2705

Fortinet Inc.
Get /system/debug/logger-names

Get /system/debug/logger-names

Description

Returns the current list of loggers defined for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/logger-names

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2706

Fortinet Inc.
Get /system/debug/logger-names

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
"org.hibernate.engine.transaction.spi.AbstractTransactionImpl",
"org.hibernate.engine.spi.CascadingAction",
"org.snmp4j.security.AuthGeneric",
"yams.Fortinet",
"yams.dpc.SSHMethod",
"org.snmp4j.agent.mo.snmp.UsmMIB",
"net.sf.ehcache.config.ConfigurationFactory",
"org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/].
[default]",
"org.hibernate.mapping.SimpleValue",
"yams.RadiusAttributeGroupMgr",
"yams.ArubaIAPlugin",
"org.hibernate.cfg.beanvalidation.TypeSafeActivator",
"yams.ScannerManager",
"org.snmp4j.smi.AbstractVariable",
"yams.NetFlowServer",
"org.snmp4j.agent.mo.MOScalar",
"org.apache.tomcat.util.net.SSLUtilBase",
"org.hibernate.event.internal.DefaultDirtyCheckEventListener",
]
}

FortiNAC F 7.4.0 REST API 2707

Fortinet Inc.
Get /system/debug/plugin/resources/reloaders

Get /system/debug/plugin/resources/reloaders

Description

Returns the list of plugins able to dynamically reload system resources.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request GET https://10.106.94.152:8443/api/v2/system/debug/plugin/resources/reloaders

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2708

Fortinet Inc.
Get /system/debug/plugin/resources/reloaders

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2709

Fortinet Inc.
Get /system/debug/plugin-names

Get /system/debug/plugin-names

Description

Returns the current list of plugins defined for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/plugin-names

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2710

Fortinet Inc.
Get /system/debug/plugin-names

Sample Response

FortiNAC F 7.4.0 REST API 2711

Fortinet Inc.
Get /system/debug/plugin-names

{
"status": "success",
"errorMessage": null,
"results": [
"MasterLoader",
"EntitlementServer",
"ResourceInterface",
"RelationInterface",
"HibernateServer",
"RadiusDictionaryMgr",
"RadiusAttributeGroupMgr",
"ManagedElementInterface",
"GlobalOptionManager",
"ForwardingPropertyManager",
"ManagedGroupInterface",
"UserRecordServer",
"HostServer",
"ValidMAC",
"DynamicClient",
"MultiFilterInterface",
"SchedulerInterface",
"FortigateConfig",
"RadiusCertificateOwner_radius",
"Nessus",
"PortalManager",
"PortalCertOwner",
"ReadFromLeaseFileServer",
"CaptivePortal",
"DhcpWatcher",
"P0fWatcher",
"ActiveFingerprint",
"WinRMCerts",
"SecurityManager",
"DHCPFileServer",
"AgentServer",
"AgentManagement",
"PersistentAgent",
"PersistentAgentCerts",
"WebServiceDefinitionManager",
"PortalServer",
"Nessus",
"PortalManager",
"PortalCertOwner",
"ReadFromLeaseFileServer",
"CaptivePortal",
"DhcpWatcher",
"P0fWatcher",
"ActiveFingerprint",
"WinRMCerts",
"SecurityManager",
"DHCPFileServer",
"AgentServer",
"AgentManagement",
"PersistentAgent",
"PersistentAgentCerts",
"WebServiceDefinitionManager",
"PortalServer"
]
}

FortiNAC F 7.4.0 REST API 2712

Fortinet Inc.
Get /system/debug/plugin-performance

Get /system/debug/plugin-performance

Description

Gets the current performance statistics for the supplied plugin.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

pluginName Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/plugin-

performance

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body pluginName: "EntitlementServer"

FortiNAC F 7.4.0 REST API 2713

Fortinet Inc.
Get /system/debug/plugin-performance

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2714

Fortinet Inc.
Get /system/debug/plugin-status

Get /system/debug/plugin-status

Description

Returns the debug status for all plugins.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/debug/plugin-status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2715

Fortinet Inc.
Get /system/debug/plugin-status

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"loader": "string",
"debugEnabled": true
}
]
}

FortiNAC F 7.4.0 REST API 2716

Fortinet Inc.
Post /system/debug/grabLogSnapshot-start

Post /system/debug/grabLogSnapshot-start

Description

Start collecting a grab log snapshot.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/debug/grabLogSnapshot-start

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"hostname": "string",
"type": "string",
"zipPassword": "string",
"taskTranslations": {
"bgTaskMsg": "string",
"bgTaskCompleteMsg": "string",
"bgTaskLogDownloadedMsg": "string",
"bgTaskLogDownloadFailedMsg": "string"
}
}

FortiNAC F 7.4.0 REST API 2717

Fortinet Inc.
Post /system/debug/grabLogSnapshot-start

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": 0,
"state": "string"
}

FortiNAC F 7.4.0 REST API 2718

Fortinet Inc.
Post /system/debug/gui/snapshot

Post /system/debug/gui/snapshot

Description

Sends an e-mail to FortiNAC support using the configured SMTP server containing a provided snapshot from the GUI.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

recipient Required String

subject Required String

message Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/debug/gui/snapshot

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body recipient: [email protected]

subject: "Request for support"
message: "Please provide support for FortiNAC"

FortiNAC F 7.4.0 REST API 2719

Fortinet Inc.
Post /system/debug/gui/snapshot

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2720

Fortinet Inc.
Post /system/debug/plugin

Post /system/debug/plugin

Description

Sets the debug status to be enabled or disabled for one or more plugins.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

enable Required Boolean

plugin Required Array

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/debug/plugin

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body enable: True

plugin: "EntitlementServer"

FortiNAC F 7.4.0 REST API 2721

Fortinet Inc.
Post /system/debug/plugin

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2722

Fortinet Inc.
Post /system/debug/plugin/resources/reload

Post /system/debug/plugin/resources/reload

Description

Issues a request for the plugin to reload system resources or device mappings, if supported.

Request Parameter

Name Required Type

name Required String

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

reloadType Required String

FortiNAC F 7.4.0 REST API 2723

Fortinet Inc.
Post /system/debug/plugin/resources/reload

Sample Request

Requ POST https://10.106.94.152:8443/api/v2/system/debug/plugin/resourc

est es/reload
URL
Requ Authorization: Bearer <Authorization_Token>
est Content-Type: application/json
Heade
r
Requ name: "xxxxxxxxxx"
est reloadType: "xxxxxx"
Body

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2724

Fortinet Inc.
Post /system/debug/elements/attributes/delete

Post /system/debug/elements/attributes/delete

Description

Deletes one or more attributes stored by the system on the elements of a given type and DBID. Allowed types are host,
adapter, user, device, and nselem.

Request Parameters

Name Required Type

type Required String

id Required Integer

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

attrName Required Array

FortiNAC F 7.4.0 REST API 2725

Fortinet Inc.
Post /system/debug/elements/attributes/delete

Sample Request

Request POST https://10.106.94.152:8443/api/v2/system/debug/elements/attributes/delete

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request attrName: "xxxxxxxxx"

Body

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2726

Fortinet Inc.
Post /system/debug/elements/attributes/set

Post /system/debug/elements/attributes/set

Description

Sets one or more attributes stored by the system on the elements of a given type and DBID. Allowed types are host,
adapter, user, device, and nselem.

Request Parameters

Name Required Type

type Required String

id Required Integer

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

attrName Required Array

attrVal Required String

isModify Required Boolean

FortiNAC F 7.4.0 REST API 2727

Fortinet Inc.
Post /system/debug/elements/attributes/set

Sample Request

Request POST https://10.106.94.152:8443/api/v2/system/debug/elements/attributes/set

URL
Request Authorization: Bearer <Authorization_Token>
Header Content-Type: application/json

Request attrName: "xxxxxxxxx"

Body attrVal: "xxxxxx"
isModify: False

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2728

Fortinet Inc.
System Updates

System Updates

FortiNAC F 7.4.0 REST API 2729

Fortinet Inc.
Get /settings/updates/system-updates

Get /settings/updates/system-updates

Description

Returns the System Updates settings

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

revertToDefaults Required Boolean

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/updates/system-

updates

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body revertToDefaults: false

FortiNAC F 7.4.0 REST API 2730

Fortinet Inc.
Get /settings/updates/system-updates

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"logs": [
"string"
],
"host": "string",
"user": "string",
"pw": "string",
"protocol": "string",
"dir": "string",
"productDir": "string",
"agentDir": "string",
"readmeFoundMsg": "string",
"hasReadme": "string",
"isNCM": "string",
"password": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2731

Fortinet Inc.
Get /settings/updates/system-updates/download-version

Get /settings/updates/system-updates/download-version

Description

Returns the available download version.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/updates/system-

updates/download-version

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2732

Fortinet Inc.
Get /settings/updates/system-updates/download-version

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2733

Fortinet Inc.
Get /settings/updates/system-updates/file-data

Get /settings/updates/system-updates/file-data

Description

Returns the System Install FileNames

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/updates/system-

updates/file-data

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2734

Fortinet Inc.
Get /settings/updates/system-updates/file-data

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2735

Fortinet Inc.
Get /settings/updates/system-updates/logs

Get /settings/updates/system-updates/logs

Description

Returns the System Update log.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

logName Required String

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/updates/system-

updates/logs

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body logName: ""

FortiNAC F 7.4.0 REST API 2736

Fortinet Inc.
Get /settings/updates/system-updates/logs

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2737

Fortinet Inc.
Get /settings/updates/system-updates/password

Get /settings/updates/system-updates/password

Description

Returns the currently configured system update password.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/updates/system-

updates/password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2738

Fortinet Inc.
Get /settings/updates/system-updates/password

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2739

Fortinet Inc.
Post /settings/updates/system-updates

Post /settings/updates/system-updates

Description

Configures system update settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/updates/system-

updates

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"results": [
{
"logs": [
"string"
],
"host": "string",
"user": "string",
"pw": "string",
"protocol": "string",
"dir": "string",
"productDir": "string",
"agentDir": "string",
"readmeFoundMsg": "string",

FortiNAC F 7.4.0 REST API 2740

Fortinet Inc.
Post /settings/updates/system-updates

"hasReadme": "string",
"isNCM": "string",
"password": "string"
}
]
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2741

Fortinet Inc.
Post /settings/updates/system-updates/test

Post /settings/updates/system-updates/test

Description

Test the system update settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/updates/system-

updates

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"status": "string",
"errorMessage": "string",
"results": [
{
"logs": [
"string"
],
"host": "string",
"user": "string",
"pw": "string",
"protocol": "string",
"dir": "string",
"productDir": "string",
"agentDir": "string",
"readmeFoundMsg": "string",

FortiNAC F 7.4.0 REST API 2742

Fortinet Inc.
Post /settings/updates/system-updates/test

"hasReadme": "string",
"isNCM": "string",
"password": "string"
}
]
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2743

Fortinet Inc.
Task

Task

FortiNAC F 7.4.0 REST API 2744

Fortinet Inc.
Get /system/task

Get /system/task

Description

Returns all task records which match the supplied fitler.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/task

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2745

Fortinet Inc.
Get /system/task

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 1,
"state": 0,
"elementType": 100,
"nameTag": "SECURITY_RESCAN",
"scheduledObjectType": 10,
"eventTag": "SECURITY_RESCAN",
"taskType": 3,
"version": 1.2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-05T02:29:19.337+0000",
"lastChangeSummary": "",
"taskValue": "SecurityManager",
"auditObjectName": "SECURITY_RESCAN",
"auditObjectType": null,
"modifyAuditSummary": null,
"addAuditSummary": null
},
{
"landscape": 345052093136,
"id": 2,
"state": 0,
"elementType": 20,
"nameTag": "VERIFY_DHCP",
"scheduledObjectType": 2,
"eventTag": "VERIFY_DHCP",
"taskType": 3,
"version": 1.2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-05T02:29:19.338+0000",
"lastChangeSummary": "",
"taskValue": "DHCPProbe",
"auditObjectName": "VERIFY_DHCP",
"auditObjectType": null,
"modifyAuditSummary": null,
"addAuditSummary": null
}
],
"filtered": 2,
"total": 34
}

FortiNAC F 7.4.0 REST API 2746

Fortinet Inc.
Get /system/task/count

Get /system/task/count

Description

Returns a count of all task records that match the filter specification.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array[String]

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/task/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2747

Fortinet Inc.
Get /system/task/count

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 34
}

FortiNAC F 7.4.0 REST API 2748

Fortinet Inc.
Get /system/task/count/all

Get /system/task/count/all

Description

Returns the count of all task records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2749

Fortinet Inc.
Get /system/task/count/all

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [],
"filtered": null,
"total": 34
}

FortiNAC F 7.4.0 REST API 2750

Fortinet Inc.
Get /system/task/{id}

Get /system/task/{id}

Description

Returns all task records with the supplied DBID.

Request Parameter

Id, the task record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/task/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2751

Fortinet Inc.
Get /system/task/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 1,
"state": 0,
"elementType": 100,
"nameTag": "SECURITY_RESCAN",
"scheduledObjectType": 10,
"eventTag": "SECURITY_RESCAN",
"taskType": 3,
"version": 1.2,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-05T02:29:19.337+0000",
"lastChangeSummary": "",
"taskValue": "SecurityManager",
"auditObjectName": "SECURITY_RESCAN",
"auditObjectType": null,
"modifyAuditSummary": null,
"addAuditSummary": null
}
],
"filtered": 2,
"total": 34
}

FortiNAC F 7.4.0 REST API 2752

Fortinet Inc.
Get /system/task/{id}/usage

Get /system/task/{id}/usage

Description

Returns a list of task records that reference this record.

Request Parameter

Id, the task record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/task/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2753

Fortinet Inc.
Get /system/task/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null
"results": []
}

FortiNAC F 7.4.0 REST API 2754

Fortinet Inc.
Post /system/task

Post /system/task

Description

Adds a new task record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/task

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"state": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"eventTag": "string",
"taskType": "string",
"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-14T23:38:43.553Z",
"lastChangeSummary": "string",
"message": "string",
"description": "string",
"removeMessage": "string",
"modifyAuditSummary": "string",

FortiNAC F 7.4.0 REST API 2755

Fortinet Inc.
Post /system/task

"name": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2756

Fortinet Inc.
Post /system/task/{id}

Post /system/task/{id}

Description

Updates an existing task record in the database.

Request Parameter

Id, the task record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/task/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 1,
"state": "string",
"elementType": "string",
"nameTag": "string",
"scheduledObjectType": "string",
"eventTag": "string",
"taskType": "string",

FortiNAC F 7.4.0 REST API 2757

Fortinet Inc.
Post /system/task/{id}

"version": 0,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-14T23:38:43.553Z",
"lastChangeSummary": "string",
"message": "string",
"description": "string",
"removeMessage": "string",
"modifyAuditSummary": "string",
"name": "string",
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2758

Fortinet Inc.
Post /system/task/delete

Post /system/task/delete

Description

Deletes the task record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array[Integer]

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/system/task/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2759

Fortinet Inc.
Post /system/task/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2760

Fortinet Inc.
Post /system/task/{id}/delete

Post /system/task/{id}/delete

Description

Deletes the task record supplied, if they are not currently in use.

Request Parameter

Id, the task record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/task/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2761

Fortinet Inc.
Post /system/task/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2762

Fortinet Inc.
Delete /system/task/{id}

Delete /system/task/{id}

Description

Deletes the task record supplied, if it is not currently in use.

Request Parameter

Id, the task record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/system/task/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2763

Fortinet Inc.
Delete /system/task/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2764

Fortinet Inc.
TLS Service Configuration

TLS Service Configuration

FortiNAC F 7.4.0 REST API 2765

Fortinet Inc.
Get /settings/tls-service-configuration

Get /settings/tls-service-configuration

Description

Returns a list of TLS service Configuration records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2766

Fortinet Inc.
Get /settings/tls-service-configuration

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"id": 1,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-05T02:29:42.000+0000",
"name": "Admin UI 32884c06-7031-401f-a5d8-607cf2f2e7dd",
"ciphers": "TLS_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_
SHA256",
"tlsProtocols": "TLSv1.3,TLSv1.2",
"certAlias": "tomcat",
"clientAuthMode": "OPTIONAL",
"clientAuthAliases": null,
"autoUpdateCiphersAndProtocols": false,
"globalModifiedDate": "2023-08-25T16:50:43.000+0000",
"GUID": null
}
],
"filtered": 1,
"total": 8
}

FortiNAC F 7.4.0 REST API 2767

Fortinet Inc.
Get /settings/tls-service-configuration/{id}

Get /settings/tls-service-configuration/{id}

Description

Returns a list of TLS service Configuration records matching the supplied filter.

Request Parameter

Id, the TLS service Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2768

Fortinet Inc.
Get /settings/tls-service-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"id": 1,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-05T02:29:42.000+0000",
"name": "Admin UI 32884c06-7031-401f-a5d8-607cf2f2e7dd",
"ciphers": "TLS_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_
SHA256",
"tlsProtocols": "TLSv1.3,TLSv1.2",
"certAlias": "tomcat",
"clientAuthMode": "OPTIONAL",
"clientAuthAliases": null,
"autoUpdateCiphersAndProtocols": false,
"globalModifiedDate": "2023-08-25T16:50:43.000+0000",
"GUID": null
}
],
"filtered": 1,
"total": 8
}

FortiNAC F 7.4.0 REST API 2769

Fortinet Inc.
Get /settings/tls-service-configuration/{id}/usage

Get /settings/tls-service-configuration/{id}/usage

Description

Returns a list of TLS Service Configuration records that reference this record.

Request Parameter

Id, the TLS service Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2770

Fortinet Inc.
Get /settings/tls-service-configuration/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2771

Fortinet Inc.
Get /settings/tls-service-configuration/radiusciphers

Get /settings/tls-service-configuration/radiusciphers

Description

Returns the list of iana ciphers with a corresponding openssi version for use with radius.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/radiusciphers

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2772

Fortinet Inc.
Get /settings/tls-service-configuration/radiusciphers

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"value": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"recommended": true
},
{
"value": "TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384",
"recommended": true
}
]
}

FortiNAC F 7.4.0 REST API 2773

Fortinet Inc.
Get /settings/tls-service-configuration/aliases

Get /settings/tls-service-configuration/aliases

Description

Returns the list of aliases available to the certificate manager.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

type Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/aliases

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body type: "tomcat"

FortiNAC F 7.4.0 REST API 2774

Fortinet Inc.
Get /settings/tls-service-configuration/aliases

Sample Response

{
"status": "success",
"errorMessage": null,
"results": {
"radsec": "Local RADIUS Server (RadSec)",
"agent": "Persistent Agent",
"tomcat": "Admin UI",
"radius": "Local RADIUS Server (EAP) [radius]",
"portal": "Portal"
}
}

FortiNAC F 7.4.0 REST API 2775

Fortinet Inc.
Post /settings/tls-service-configuration

Post /settings/tls-service-configuration

Description

Creates a new TLS Service Configuration record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

{
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-02-15T18:58:26.646Z",
"gUID": 0,
"id": 0
}

FortiNAC F 7.4.0 REST API 2776

Fortinet Inc.
Post /settings/tls-service-configuration

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-15T18:58:26.647Z",
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-02-15T18:58:26.647Z",
"gUID": 0,
"id": 0
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2777

Fortinet Inc.
Post /settings/tls-service-configuration/delete

Post /settings/tls-service-configuration/delete

Description

Deletes a list of TLS Service Configuration records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array[Integer]

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 2778

Fortinet Inc.
Post /settings/tls-service-configuration/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2779

Fortinet Inc.
Post /settings/tls-service-configuration/deploy

Post /settings/tls-service-configuration/deploy

Description

Reinitializes Persistent Agent transports from the configurations in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/deploy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2780

Fortinet Inc.
Post /settings/tls-service-configuration/deploy

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2781

Fortinet Inc.
Post /settings/tls-service-configuration/{id}/delete

Post /settings/tls-service-configuration/{id}/delete

Description

Deletes a single TLS Service Configuration record by ID.

Request Parameter

Id, the TLS service Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2782

Fortinet Inc.
Post /settings/tls-service-configuration/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2783

Fortinet Inc.
Post /settings/tls-service-configuration/{id}

Post /settings/tls-service-configuration/{id}

Description

Updates an TLS Service Configuration record.

Request Parameter

Id, the TLS service Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

{
"clientAuthMode": "string",
"name": "string",
"ciphers": "string",
"tlsProtocols": "string",
"certAlias": "string",
"clientAuthAliases": "string",
"autoUpdateCiphersAndProtocols": true,
"globalModifiedDate": "2024-02-15T18:58:26.646Z",

FortiNAC F 7.4.0 REST API 2784

Fortinet Inc.
Post /settings/tls-service-configuration/{id}

"gUID": 0,
"id": 1
}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2785

Fortinet Inc.
Delete /settings/tls-service-configuration/{id}

Delete /settings/tls-service-configuration/{id}

Description

Deletes a single TLS Service Configuration record by ID.

Request Parameter

Id, the TLS service Configuration record Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/tls-service-

configuraiton/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2786

Fortinet Inc.
Delete /settings/tls-service-configuration/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2787

Fortinet Inc.
Trap MIB

Trap MIB

FortiNAC F 7.4.0 REST API 2788

Fortinet Inc.
Get /settings/integration/trap-mib

Get /settings/integration/trap-mib

Description

Returns all TrapMibs.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/trap-mib

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2789

Fortinet Inc.
Get /settings/integration/trap-mib

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"name": "string",
"children": [
{
"name": "string",
"oid": "string",
"label": "string",
"entOid": "string",
"ipOid": "string",
"macOid": "string",
"userOid": "string",
"specificType": "string",
"alarmCause": "string",
"evtFormat": "string",
"eventFormat": "string",
"enterpriseOID": "string",
"ipaddressOID": "string",
"macaddressOID": "string",
"userIDOID": "string"
}
]
}
]
}

FortiNAC F 7.4.0 REST API 2790

Fortinet Inc.
Post /settings/integration/trap-mib/add

Post /settings/integration/trap-mib/add

Description

Adds a new trap mib if a trap mib with the name does not exist and adds a new trap object to the trap mib if a trap mib
already exists with the name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

oid Required String

label Required String

entOid Required String

ipOid Required String

macOid Required String

userOid Required String

specificType Required String

alarmCause Required String

evtFormat Required String

FortiNAC F 7.4.0 REST API 2791

Fortinet Inc.
Post /settings/integration/trap-mib/add

Name Required Type

eventFormat Required String

enterpriseOID Required String

ipaddressOID Required String

macaddressOID Required String

userIDOID Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/trap-

mib/add

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "xxxxxxxxxxxxx"

oid: "xxxxxxxxxxxxx"
label: "xxxxxxxxxxxxx"
entOid: "xxxxxxxxxxxxx"
ipOid: "xxxxxxxxxxxxx"
macOid: "xxxxxxxxxxxxx"
userOid: "xxxxxxxxxxxxx"
specificType: "xxxxxxxxxxxxx"
alarmCause: "xxxxxxxxxxxxx"
evtFormat: "xxxxxxxxxxxxx"
eventFormat: "xxxxxxxxxxxxx"
enterpriseOID: "xxxxxxxxxxxxx"
ipaddressOID: "xxxxxxxxxxxxx"
macaddressOID: "xxxxxxxxxxxxx"
userIDOID: "xxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2792

Fortinet Inc.
Post /settings/integration/trap-mib/add

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2793

Fortinet Inc.
Post /settings/integration/trap-mib/delete

Post /settings/integration/trap-mib/delete

Description

Deletes Trap Objects supplied in the list.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/trap-

mib/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"mibOids": [
{
"name": "string",
"oid": "string"
}
],
"mibNames": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2794

Fortinet Inc.
Post /settings/integration/trap-mib/delete

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 2795

Fortinet Inc.
Post /settings/integration/trap-mib/mib-name

Post /settings/integration/trap-mib/mib-name

Description

Updates the Mib File Name with the supplied name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

oid Required String

label Required String

entOid Required String

ipOid Required String

macOid Required String

userOid Required String

specificType Required String

alarmCause Required String

evtFormat Required String

eventFormat Required String

FortiNAC F 7.4.0 REST API 2796

Fortinet Inc.
Post /settings/integration/trap-mib/mib-name

Name Required Type

enterpriseOID Required String

ipaddressOID Required String

macaddressOID Required String

userIDOID Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/trap-

mib/mib-name

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "xxxxxxxxxxxxx"

oid: "xxxxxxxxxxxxx"
label: "xxxxxxxxxxxxx"
entOid: "xxxxxxxxxxxxx"
ipOid: "xxxxxxxxxxxxx"
macOid: "xxxxxxxxxxxxx"
userOid: "xxxxxxxxxxxxx"
specificType: "xxxxxxxxxxxxx"
alarmCause: "xxxxxxxxxxxxx"
evtFormat: "xxxxxxxxxxxxx"
eventFormat: "xxxxxxxxxxxxx"
enterpriseOID: "xxxxxxxxxxxxx"
ipaddressOID: "xxxxxxxxxxxxx"
macaddressOID: "xxxxxxxxxxxxx"
userIDOID: "xxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2797

Fortinet Inc.
Post /settings/integration/trap-mib/mib-name

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2798

Fortinet Inc.
Post /settings/integration/trap-mib/update

Post /settings/integration/trap-mib/update

Description

Updates the trap object with mib file name change if supplied name is different from original name and updates the trap
object with mib file name change if the supplied name is same as original name.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

name Required String

oid Required String

label Required String

entOid Required String

ipOid Required String

macOid Required String

userOid Required String

specificType Required String

alarmCause Required String

evtFormat Required String

FortiNAC F 7.4.0 REST API 2799

Fortinet Inc.
Post /settings/integration/trap-mib/update

Name Required Type

eventFormat Required String

enterpriseOID Required String

ipaddressOID Required String

macaddressOID Required String

userIDOID Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/trap-

mib/update

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body name: "xxxxxxxxxxxxx"

oid: "xxxxxxxxxxxxx"
label: "xxxxxxxxxxxxx"
entOid: "xxxxxxxxxxxxx"
ipOid: "xxxxxxxxxxxxx"
macOid: "xxxxxxxxxxxxx"
userOid: "xxxxxxxxxxxxx"
specificType: "xxxxxxxxxxxxx"
alarmCause: "xxxxxxxxxxxxx"
evtFormat: "xxxxxxxxxxxxx"
eventFormat: "xxxxxxxxxxxxx"
enterpriseOID: "xxxxxxxxxxxxx"
ipaddressOID: "xxxxxxxxxxxxx"
macaddressOID: "xxxxxxxxxxxxx"
userIDOID: "xxxxxxxxxxxxx"

FortiNAC F 7.4.0 REST API 2800

Fortinet Inc.
Post /settings/integration/trap-mib/update

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2801

Fortinet Inc.
Delete /settings/integration/trap-mib

Delete /settings/integration/trap-mib

Description

Deletes Trap MIBs supplied in the list.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/trap-mib

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"mibNames": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2802

Fortinet Inc.
Delete /settings/integration/trap-mib

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 2803

Fortinet Inc.
Delete /settings/integration/trap-mib/trap-oid

Delete /settings/integration/trap-mib/trap-oid

Description

Deletes Trap Objects supplied in the list.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/integration/trap-

mib/trap-oid

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body [
{
"name": "string",
"oid": "string"
}
]

FortiNAC F 7.4.0 REST API 2804

Fortinet Inc.
Delete /settings/integration/trap-mib/trap-oid

Sample Response

{
"status": "string",
"errorMessage": "string",
}

FortiNAC F 7.4.0 REST API 2805

Fortinet Inc.
Update

Update

FortiNAC F 7.4.0 REST API 2806

Fortinet Inc.
Post /system/update/test

Post /system/update/test

Description

Tests the current System Update settings for auto-definition updates, product distribution, and agent distribution.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

testHost Required String

testAutoDefDir Required String

testProductDistDir Required String

testAgentDistDir Required String

testUser Required String

testPassword Required String

decodePW Required String

protocol Required String

FortiNAC F 7.4.0 REST API 2807

Fortinet Inc.
Post /system/update/test

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/system/update/test

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body testHost: "xxxxxxxxx"

testAutoDefDir: "xxxxxxxxx"
testProductDistDir: "xxxxxxxxx"
testAgentDistDir: "xxxxxxxxx"
testUser: "xxxxxxxxx"
testPassword: "xxxxxxxxx"
decodePW: "xxxxxxxxx"
protocol: "xxxxxxxxx"

Sample Response

{
"status": "string",
"errorMessage": "string"
"result": "string"
}

FortiNAC F 7.4.0 REST API 2808

Fortinet Inc.
USB Detection

USB Detection

FortiNAC F 7.4.0 REST API 2809

Fortinet Inc.
Get /settings/agent/usb-detection

Get /settings/agent/usb-detection

Description

Returns the USB Detection settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2810

Fortinet Inc.
Get /settings/agent/usb-detection

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"hostGroups": [
{
"id": "string",
"name": "string"
}
],
"usbEnabled": true,
"exceptionsGroup": "string"
}
}

FortiNAC F 7.4.0 REST API 2811

Fortinet Inc.
Get /settings/agent/usb-detection/alarm-mappings

Get /settings/agent/usb-detection/alarm-mappings

Description

Returns the USB Alarm mappings

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection/alarm-mappings

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2812

Fortinet Inc.
Get /settings/agent/usb-detection/alarm-mappings

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"usbDetectedMappingID": "string",
"usbAddedMappingID": "string",
"usbRemovedMappingID": "string"
}
}

FortiNAC F 7.4.0 REST API 2813

Fortinet Inc.
Get /settings/agent/usb-detection/usb-filters

Get /settings/agent/usb-detection/usb-filters

Description

Returns the USB Filters.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL Get https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection/usb-filters

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2814

Fortinet Inc.
Get /settings/agent/usb-detection/usb-filters

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"filters": [
{
"id": 0,
"name": "string",
"friendlyName": "string",
"devClass": "string",
"devID": "string"
}
],
"total": 0
}
}

FortiNAC F 7.4.0 REST API 2815

Fortinet Inc.
Post /settings/agent/usb-detection/delete-filters

Post /settings/agent/usb-detection/delete-filters

Description

Deletes a list of USB Filters.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array[Integer]

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection/delete-filters

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

FortiNAC F 7.4.0 REST API 2816

Fortinet Inc.
Post /settings/agent/usb-detection/delete-filters

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2817

Fortinet Inc.
Post /settings/agent/usb-detection/usb-filters

Post /settings/agent/usb-detection/usb-filters

Description

Adds or modifies the USB Filters.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection/usb-filters

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"id": 0,
"name": "string",
"friendlyName": "string",
"devClass": "string",
"devID": "string"
}

FortiNAC F 7.4.0 REST API 2818

Fortinet Inc.
Post /settings/agent/usb-detection/usb-filters

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2819

Fortinet Inc.
Post /settings/agent/usb-detection

Post /settings/agent/usb-detection

Description

Adds or modifies the USB Detection Settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/agent/usb-

detection

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"hostGroups": [
{
"id": "string",
"name": "string"
}
],
"usbEnabled": true,
"exceptionsGroup": "string"
}

FortiNAC F 7.4.0 REST API 2820

Fortinet Inc.
Post /settings/agent/usb-detection

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2821

Fortinet Inc.
User

User

FortiNAC F 7.4.0 REST API 2822

Fortinet Inc.
Get /user/attributes/{name}

Get /user/attributes/{name}

Description

Returns the value currently stored for the requested attribute on the API user.

Request Parameter

Name, the name of the attribute.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/attributes/xxxx

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2823

Fortinet Inc.
Get /user/attributes/{name}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2824

Fortinet Inc.
Get /user/attributes/user/{name}

Get /user/attributes/user/{name}

Description

Returns the value currently stored for the requested attribute on the API user.

Request Parameter

Name, the name of the attribute.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Required String

name Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/attributes/user/xxxxx

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2825

Fortinet Inc.
Get /user/attributes/user/{name}

Content-Type: application/json

Request Body userID: xxxxx

name:xxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"resutl": []
}

FortiNAC F 7.4.0 REST API 2826

Fortinet Inc.
Get /user/current-session/cache

Get /user/current-session/cache

Description

Returns the cached value in the current user session. Used by the GUI for storing temporary values that don't belong in
the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

key Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-session/cache

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body key:xxxxxxx

FortiNAC F 7.4.0 REST API 2827

Fortinet Inc.
Get /user/current-session/cache

Sample Response

{
"status": "success",
"errorMessage": null,
"timeout": 0
}

FortiNAC F 7.4.0 REST API 2828

Fortinet Inc.
Get /user/current-session/feature-visibility

Get /user/current-session/feature-visibility

Description

Returns the currently enabled features for the system. This is a global setting for all users.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-

session/feature-visibility

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2829

Fortinet Inc.
Get /user/current-session/feature-visibility

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"unifiedSettings": true,
"legacyViews": true
}
}

FortiNAC F 7.4.0 REST API 2830

Fortinet Inc.
Get /user/current-session/bookmark

Get /user/current-session/bookmark

Description

Returns a list of User Bookmark records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-

session/bookmark

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2831

Fortinet Inc.
Get /user/current-session/bookmark

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"userDBID": 0,
"pageUUID": "string"
}
],
"filtered": 0,
"total": 0
}

FortiNAC F 7.4.0 REST API 2832

Fortinet Inc.
Get /user/current-session/timeout

Get /user/current-session/timeout

Description

Returns the number of seconds until the session for the current user expires.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-

session/timeout

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2833

Fortinet Inc.
Get /user/current-session/timeout

Sample Response

{
"status": "success",
"errorMessage": null,
"timeout": 0
}

FortiNAC F 7.4.0 REST API 2834

Fortinet Inc.
Get /user/current-session/securityKey

Get /user/current-session/securityKey

Description

Returns the Security Key for the current session that must be appended to every request to verify its source.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-

session/securityKey

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2835

Fortinet Inc.
Get /user/current-session/securityKey

Sample Response

FortiNAC F 7.4.0 REST API 2836

Fortinet Inc.
Get /user/current-session/securityKey

{
"status": "string",
"errorMessage": "string",
"bookmarks": [
{
"dbid": 0,
"userDBID": 0,
"pageUUID": "string"
}
],
"dashboards": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"canDelete": true,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-20T19:42:21.818Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"featureVisibility": {
"unifiedSettings": true,
FortiNAC F"legacyViews":
7.4.0 REST API true 2837
Fortinet} Inc.
}
Get /user/current-session/navigation-settings

Get /user/current-session/navigation-settings

Description

Returns the full set of navigation available and favorited by the user, including any custom dashboards and navigation
features settings.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/current-

session/navigation-settings

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2838

Fortinet Inc.
Get /user/current-session/navigation-settings

Sample Response

FortiNAC F 7.4.0 REST API 2839

Fortinet Inc.
Get /user/current-session/navigation-settings

{
"status": "string",
"errorMessage": "string",
"sessionKey": "string",
"userRecord": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-16T16:43:02.495Z",
"validForTime": "2024-02-16T16:43:02.495Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-16T16:43:02.495Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
FortiNAC F 7.4.0
], REST API 2840
Fortinet Inc. "unicodeLocaleAttributes": [
"string"
],
Post /user/attributes/{name}

Post /user/attributes/{name}

Description

Sets the value currently stored for the requested attribute on the API user.

Request Parameter

Name, the name of the attribute.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

value Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/attributes/

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2841

Fortinet Inc.
Post /user/attributes/{name}

Request Body value: xxxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
"resutl": []
}

FortiNAC F 7.4.0 REST API 2842

Fortinet Inc.
Post /user/attributes/user/{name}

Post /user/attributes/user/{name}

Description

Sets the value currently stored for the requested attribute on the target user.

Request Parameter

Name, the name of the attribute.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Optional String

value Optional String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/attributes/user/xxxx

Request Header Authorization: Bearer <Authorization_Token>

FortiNAC F 7.4.0 REST API 2843

Fortinet Inc.
Post /user/attributes/user/{name}

Content-Type: application/json

Request Body userID: xxxxxxx

value:xxxxxxxxxx

Sample Response

{
"status": "success",
"errorMessage": null,
}

FortiNAC F 7.4.0 REST API 2844

Fortinet Inc.
Post /user/current-session/bookmark/{id}

Post /user/current-session/bookmark/{id}

Description

Updates a User Bookmark record.

Request Parameter

Id, the id of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"userDBID": 0,
"pageUUID": "string"
}

FortiNAC F 7.4.0 REST API 2845

Fortinet Inc.
Post /user/current-session/bookmark/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2846

Fortinet Inc.
Post /user/current-session/bookmark/uuid/{uuid}/delete

Post /user/current-session/bookmark/uuid/{uuid}/delete

Description

Deletes a list of User Bookmark records supplied under the id parameter.

Request Parameter

uuid, the id parameter of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/uuid/xxxxxxxxx/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2847

Fortinet Inc.
Post /user/current-session/bookmark/uuid/{uuid}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2848

Fortinet Inc.
Post /user/current-session/bookmark

Post /user/current-session/bookmark

Description

Creates a new User Bookmark record, updating instead if the supplied policy has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"userDBID": 0,
"pageUUID": "string"
}

FortiNAC F 7.4.0 REST API 2849

Fortinet Inc.
Post /user/current-session/bookmark

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2850

Fortinet Inc.
Post /user/current-session/bookmark/delete

Post /user/current-session/bookmark/delete

Description

Deletes a single user bookmark record by ID.

Request Parameter

Id, id of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2851

Fortinet Inc.
Post /user/current-session/bookmark/delete

Request Body id: 3

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2852

Fortinet Inc.
Post /user/current-session/bookmark/{id}

Post /user/current-session/bookmark/{id}

Description

Updates a User Bookmark record.

Request Parameter

Id, id of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"userDBID": 0,
"pageUUID": "string"
}

FortiNAC F 7.4.0 REST API 2853

Fortinet Inc.
Post /user/current-session/bookmark/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2854

Fortinet Inc.
Post /user/current-session/bookmark/{id}/delete

Post /user/current-session/bookmark/{id}/delete

Description

Deletes a single user bookmark record by ID.

Request Parameter

Id, id of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2855

Fortinet Inc.
Post /user/current-session/bookmark/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2856

Fortinet Inc.
Post /user/current-session/cache

Post /user/current-session/cache

Description

Caches a value in the current user session. Used by the GUI for storing temporary values that don't belong in the
database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

key Required String

value Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/cache

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body key:xxxxxxx

value: xxxxxxxx

FortiNAC F 7.4.0 REST API 2857

Fortinet Inc.
Post /user/current-session/cache

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2858

Fortinet Inc.
Post /user/current-session/bookmark/sync

Post /user/current-session/bookmark/sync

Description

Synchronizes the bookmarks for the current user to match the set of supplied UUIDs.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/sync

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"uuids": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2859

Fortinet Inc.
Post /user/current-session/bookmark/sync

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2860

Fortinet Inc.
Post /user/current-session/feature-visibility

Post /user/current-session/feature-visibility

Description

Sets the currently enabled features for the system. This is a global settings for all users.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/feature-visibility

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"unifiedSettings": true,
"legacyViews": true
}

FortiNAC F 7.4.0 REST API 2861

Fortinet Inc.
Post /user/current-session/feature-visibility

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2862

Fortinet Inc.
Post /user/current-session/initialize-root-user

Post /user/current-session/initialize-root-user

Description

Performs a login which accepts the Acceptable Usage Policy. The login step must be repeated because the session is
not valid until the Acceptable Usage Policy is accepted.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

user Required String

password Required String

newUserIdD Required String

newPassword Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/accept-usage-policy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2863

Fortinet Inc.
Post /user/current-session/initialize-root-user

Request Body user: xxxx

password: xxxxxx
newUserID: xxxxx
newPassword: xxxxx

FortiNAC F 7.4.0 REST API 2864

Fortinet Inc.
Post /user/current-session/initialize-root-user

Sample Response

FortiNAC F 7.4.0 REST API 2865

Fortinet Inc.
Post /user/current-session/initialize-root-user

{
"status": "string",
"errorMessage": "string",
"sessionKey": "string",
"userRecord": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-16T16:43:02.495Z",
"validForTime": "2024-02-16T16:43:02.495Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-16T16:43:02.495Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
FortiNAC F 7.4.0
], REST API 2866
Fortinet Inc. "unicodeLocaleAttributes": [
"string"
],
Post /user/current-session/login

Post /user/current-session/login

Description

Authenticates the user and, if successful, returns the Security Key for current session that must be appended to every
request to verify its source.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

user Required String

password Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/login

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body user: xxxx

password: xxxxxx

FortiNAC F 7.4.0 REST API 2867

Fortinet Inc.
Post /user/current-session/login

Sample Response

FortiNAC F 7.4.0 REST API 2868

Fortinet Inc.
Post /user/current-session/login

{
"status": "string",
"errorMessage": "string",
"sessionKey": "string",
"userRecord": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-16T16:43:02.495Z",
"validForTime": "2024-02-16T16:43:02.495Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-16T16:43:02.495Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
FortiNAC F 7.4.0
], REST API 2869
Fortinet Inc. "unicodeLocaleAttributes": [
"string"
],
Post /user/current-session/logout

Post /user/current-session/logout

Description

Ends and invalidates the current login session.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/logout

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2870

Fortinet Inc.
Post /user/current-session/logout

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2871

Fortinet Inc.
Post /user/current-session/accept-usage-policy

Post /user/current-session/accept-usage-policy

Description

Performs a login which accepts the Acceptable Usage Policy. The login step must be repeated because the session is
not valid until the Acceptable Usage Policy is accepted.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

user Required String

password Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/current-

session/accept-usage-policy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body user: xxxx

password: xxxxxx

FortiNAC F 7.4.0 REST API 2872

Fortinet Inc.
Post /user/current-session/accept-usage-policy

Sample Response

FortiNAC F 7.4.0 REST API 2873

Fortinet Inc.
Post /user/current-session/accept-usage-policy

{
"status": "string",
"errorMessage": "string",
"sessionKey": "string",
"userRecord": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-16T16:43:02.495Z",
"validForTime": "2024-02-16T16:43:02.495Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-16T16:43:02.495Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
FortiNAC F 7.4.0
], REST API 2874
Fortinet Inc. "unicodeLocaleAttributes": [
"string"
],
Delete /user/current-session/bookmark/{id}

Delete /user/current-session/bookmark/{id}

Description

Deletes a single user bookmark record by ID.

Request Parameter

Id, id of the user bookmark record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/current-

session/bookmark/6

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2875

Fortinet Inc.
Delete /user/current-session/bookmark/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2876

Fortinet Inc.
User Host Profile

User Host Profile

FortiNAC F 7.4.0 REST API 2877

Fortinet Inc.
Get /policy/user-host-profile

Get /policy/user-host-profile

Description

Returns a list of User/Host Profile records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/user-host-profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2878

Fortinet Inc.
Get /policy/user-host-profile

Sample Response

FortiNAC F 7.4.0 REST API 2879

Fortinet Inc.
Get /policy/user-host-profile

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T00:54:34.410Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-21T00:54:34.410Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
FortiNAC F 7.4.0 "string"
REST API 2880
Fortinet Inc. ]
}
],
Get /policy/user-host-profile/{id}

Get /policy/user-host-profile/{id}

Description

Returns a list of User/Host Profile records matching the supplied filter.

Request Parameter

Id, the id of the User/Host Profile record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/user-host-profile/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2881

Fortinet Inc.
Get /policy/user-host-profile/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2882

Fortinet Inc.
Get /policy/user-host-profile/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T00:54:34.410Z",
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-21T00:54:34.410Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
FortiNAC F 7.4.0 "string"
REST API 2883
Fortinet Inc. ]
}
],
Get /policy/user-host-profile/{id}/usage

Get /policy/user-host-profile/{id}/usage

Description

Returns a list of records that reference this User/Host Profile record.

Request Parameter

Id, the id of the User/Host Profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/user-host-

profile/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2884

Fortinet Inc.
Get /policy/user-host-profile/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2885

Fortinet Inc.
Get /policy/user-host-profile/supporting-info

Get /policy/user-host-profile/supporting-info

Description

Returns a series of related data records used to create User/Host Profiles.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/policy/user-host-

profile/supporting-info

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2886

Fortinet Inc.
Get /policy/user-host-profile/supporting-info

Sample Response

{
"status": "string",
"errorMessage": "string",
"devPortGroups": [
{
"id": 0,
"name": "string"
}
],
"devTypes": [
{
"name": "string",
"id": 0,
"tag": "string",
"iconPath": "string"
}
],
"agentPlatforms": [
{
"first": "string",
"second": "string"
}
],
"hostUserGroups": [
{
"id": 0,
"name": "string"
}
]
}

FortiNAC F 7.4.0 REST API 2887

Fortinet Inc.
Post /policy/user-host-profile

Post /policy/user-host-profile

Description

Creates a new User/Host Profile record, updating instead if the supplied profile has a DBID of one that already exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/user-host-profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-21T01:03:23.896Z",
"groupIDs": [
0
],
"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,

FortiNAC F 7.4.0 REST API 2888

Fortinet Inc.
Post /policy/user-host-profile

"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2889

Fortinet Inc.
Post /policy/user-host-profile

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2890

Fortinet Inc.
Post /policy/user-host-profile/{id}

Post /policy/user-host-profile/{id}

Description

Updates a User/Host Profile record.

Request Parameter

Id, the id of the User/Host Profile record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/user-host-

profile/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"note": "string",
"guid": 0,
"globalModifiedDate": "2024-02-21T01:03:23.896Z",
"groupIDs": [
0
],

FortiNAC F 7.4.0 REST API 2891

Fortinet Inc.
Post /policy/user-host-profile/{id}

"catchAll": true,
"weeklySchedule": {
"version": 0,
"startTimeOfDay": 0,
"endTimeOfDay": 0,
"daysOfWeek": 0,
"startTimeOfDayAM": true,
"endTimeOfDayAM": true,
"startTimeOfDayHours": 0,
"endTimeOfDayHours": 0,
"startTimeOfDayMinutes": 0,
"endTimeOfDayMinutes": 0,
"alwaysOn": true,
"validTime": true
},
"filterSet": [
"string"
],
"locationIDs": [
0
],
"locationOperator": "OR",
"groupOperator": "OR",
"radiusFilterSet": [
{
"enabled": true,
"methodType": {
"id": 0,
"name": "string",
"shortName": "string"
},
"version": 0,
"encrypted": true,
"priority": 0,
"attributeFilters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"groupNames": [
"string"
],
"locationNames": [
"string"
]
}

FortiNAC F 7.4.0 REST API 2892

Fortinet Inc.
Post /policy/user-host-profile/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": []
}

FortiNAC F 7.4.0 REST API 2893

Fortinet Inc.
Post /policy/user-host-profile/delete

Post /policy/user-host-profile/delete

Description

Deletes a list of User/Host Profile records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Optional Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/user-host-

profile/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 2894

Fortinet Inc.
Post /policy/user-host-profile/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2895

Fortinet Inc.
Post /policy/user-host-profile/{id}/delete

Post /policy/user-host-profile/{id}/delete

Description

Deletes a single User/Host Profile record by ID.

Request Parameter

Id, the id of the User/Host Profile.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/policy/user-host-

profile/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2896

Fortinet Inc.
Post /policy/user-host-profile/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2897

Fortinet Inc.
Delete /policy/user-host-profile/{id}

Delete /policy/user-host-profile/{id}

Description

Deletes a User/Host Profile record by ID.

Request Parameter

Id, the id of the User/Host Profile record.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/policy/user-host-

profile/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2898

Fortinet Inc.
Delete /policy/user-host-profile/{id}

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2899

Fortinet Inc.
User Record

User Record

FortiNAC F 7.4.0 REST API 2900

Fortinet Inc.
Get /user

Get /user

Description

Returns all user records which match the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2901

Fortinet Inc.
Get /user

Sample Response

FortiNAC F 7.4.0 REST API 2902

Fortinet Inc.
Get /user

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 3,
"role": "NAC-Default",
"directoryPolicyValue": null,
"firstName": "Admin",
"lastName": "admin",
"dn": "",
"position": "",
"email": "",
"state": 0,
"userID": "admin",
"status": 0,
"notes": "",
"language": "en",
"country": "US",
"version": 1.4,
"packedVersion": 1.4,
"creationTime": 1692982243609,
"validForTime": -1,
"validForInactivityDays": -1,
"validForInactivityAgeTime": 0,
"lastActivityTime": 1708479559407,
"address": "",
"city": "",
"mailState": "",
"zipCode": "",
"phone": "",
"organization": null,
"organizationalUnit": null,
"type": 46,
"adminProfileId": 1,
"guestId": 0,
"mobileNumber": "",
"mobileProvider": "",
"ncmPropagateHosts": true,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-21T01:39:19.408+0000",
"lastChangeSummary": "[]",
"isApiAdmin": true,
"apiAccessToken": "",
"trustedHosts": "[\"0.0.0.0/0\"]",
"localMschapAuth": false,
"maxAllowedHosts": null
}
{
"landscape": 345052093136,
"id": 4,
"role": "Guest",
"directoryPolicyValue": null,
"firstName": "Guest",
"lastName": "Access",
"dn": null,
"position": null,
"email": null,
"state": 0,
FortiNAC F 7.4.0 REST API
"userID": "guest-access", 2903
Fortinet Inc. "status": 0,
"notes": null,
"language": "en",
Get /user/count

Get /user/count

Description

Returns a count of User records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Required Array<String>

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/count

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2904

Fortinet Inc.
Get /user/count

Sample Response

FortiNAC F 7.4.0 REST API 2905

Fortinet Inc.
Get /user/count

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-05-21T22:14:29.162Z",
"validForTime": "2024-05-21T22:14:29.162Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-05-21T22:14:29.162Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"userAdministrator": true,
"adminUser": true,
"iconType": "string",
"locale": {
"displayName": "string",
"script": "string",
FortiNAC F 7.4.0 "country":
REST API "string", 2906
Fortinet Inc. "variant": "string",
"extensionKeys": [
"string"
Get /user/allowed-hosts

Get /user/allowed-hosts

Description

Returns the number of allowed hosts set per user.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/allowed-hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2907

Fortinet Inc.
Get /user/allowed-hosts

Sample Response

{
"status": "success",
"errorMessage": null,
"result": "1000"
}

FortiNAC F 7.4.0 REST API 2908

Fortinet Inc.
Get /user/{id}

Get /user/{id}

Description

Returns the user record with the supplied DBID.

Request Parameter

Id, the user record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2909

Fortinet Inc.
Get /user/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 3,
"role": "NAC-Default",
"directoryPolicyValue": null,
"firstName": "Admin",
"lastName": "admin",
"dn": "",
"position": "",
"email": "",
"state": 0,
"userID": "admin",
"status": 0,
"notes": "",
"language": "en",
"country": "US",
"version": 1.4,
"packedVersion": 1.4,
"creationTime": 1692982243609,
"validForTime": -1,
"validForInactivityDays": -1,
"validForInactivityAgeTime": 0,
"lastActivityTime": 1708479559407,
"address": "",
"city": "",
"mailState": "",
"zipCode": "",
"phone": "",
"organization": null,
"organizationalUnit": null,
"type": 46,
"adminProfileId": 1,
"guestId": 0,
"mobileNumber": "",
"mobileProvider": "",
"ncmPropagateHosts": true,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-21T01:39:19.408+0000",
"lastChangeSummary": "[]",
"isApiAdmin": true,
"apiAccessToken": "",
"trustedHosts": "[\"0.0.0.0/0\"]",
"localMschapAuth": false,
"maxAllowedHosts": null
}
],
"filtered": 1,
"total": 2
}

FortiNAC F 7.4.0 REST API 2910

Fortinet Inc.
Get /user/count/all

Get /user/count/all

Description

Returns the count of all user records in the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/count/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2911

Fortinet Inc.
Get /user/count/all

Sample Response

FortiNAC F 7.4.0 REST API 2912

Fortinet Inc.
Get /user/count/all

{
"status": "string",
"errorMessage": "string",
"results": [
{
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-05-21T22:14:29.162Z",
"validForTime": "2024-05-21T22:14:29.162Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-05-21T22:14:29.162Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"localMschapAuth": true,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"userAdministrator": true,
"adminUser": true,
"iconType": "string",
"locale": {
"displayName": "string",
"script": "string",
FortiNAC F 7.4.0 "country":
REST API "string", 2913
Fortinet Inc. "variant": "string",
"extensionKeys": [
"string"
Get /user/has-hosts

Get /user/has-hosts

Description

Returns a boolean result if the user is the owner of one or more hosts.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/has-hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

FortiNAC F 7.4.0 REST API 2914

Fortinet Inc.
Get /user/has-hosts

Sample Response

{
"status": "success",
"errorMessage": null
"result": []
}

FortiNAC F 7.4.0 REST API 2915

Fortinet Inc.
Get /user/{id}/get-policy

Get /user/{id}/get-policy

Description

Returns the policy info for a user based on the provided user it.

Request Parameter

Id, the user record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/3/get-policy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2916

Fortinet Inc.
Get /user/{id}/get-policy

Sample Response

FortiNAC F 7.4.0 REST API 2917

Fortinet Inc.
Get /user/{id}/get-policy

{
"status": "success",
"errorMessage": null,
"accessPolicy": null,
"accessPolicyDebug": ""
"supplicantPolicy": null,
"supplicantPolicyDebug": ""
"epcPolicy": null,
"epcPolicyDebug": ""
"portalPolicy": null,
"portalPolicyDebug" ""
"authenticationPolicy": {
"dbid": 3,
"rank": 2,
"version": 0,
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-09-21T22:58:21.000+0000",
"name": "Guest Self-Registration Access Policy 2",
"note": "",
"profile": {
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-09-21T22:58:21.000+0000",
"DBID": 3,
"name": "Role Test 3",
"note": "",
"locationOperator": "OR",
"groupOperator": "OR",
"GUID": null,
"globalModifiedDate": "2023-09-21T22:58:21.000+0000",
"groupNames": [],
"weeklySchedule": {
"version": 1.1,
"startTimeOfDay": -1,
"endTimeOfDay": -1,
"daysOfWeek": -1,
"alwaysOn": true,
"validTime": true,
"endTimeOfDayAM": true,
"startTimeOfDayAM": true,
"startTimeOfDayHours": 12,
"endTimeOfDayHours": 12,
"startTimeOfDayMinutes": -1,
"endTimeOfDayMinutes": -1
},
"groupIDs": [],
"locationIDs": [],
"filterSet": [],
"locationNames": [],
"radiusFilterSet": [],
"catchAll": true
},
"configuration": {
"name": "Global Authentication Conversion",
"note": "Converted from Global Authentication Policy - Fri Aug 25
13:40:35 EDT 2023",
"authenticationMethod": null,
"authenticationTime": 0,
"authenticationTimeOffLine": 600000,
"reauthentication": false,
"reauthenticationTime": 0,
FortiNAC F 7.4.0 REST API
"errorMessage": null, 2918
Fortinet Inc. "lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2023-08-25T17:40:35.000+0000",
"id": 1
Get /user/{id}/usage

Get /user/{id}/usage

Description

Returns a list of records that reference this user record.

Request Parameter

Id, the user record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/4/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2919

Fortinet Inc.
Get /user/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2920

Fortinet Inc.
Get /user/search-user-by-userID

Get /user/search-user-by-userID

Description

Retrieves user info from directory.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Required String

createNCMUser Optional Boolean

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/search-user-by-userID

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body userID: "guest-access"

FortiNAC F 7.4.0 REST API 2921

Fortinet Inc.
Get /user/search-user-by-userID

Sample Response

FortiNAC F 7.4.0 REST API 2922

Fortinet Inc.
Get /user/search-user-by-userID

{
"status": "string",
"errorMessage": "string",
"fromDirectory": true,
"userRecord": {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-21T19:51:45.914Z",
"validForTime": "2024-02-21T19:51:45.914Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T19:51:45.914Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
FortiNAC F 7.4.0
], REST API 2923
Fortinet Inc. "unicodeLocaleAttributes": [
"string"
],
Get /user/{id}/get-agent

Get /user/{id}/get-agent

Description

Retrieves the agent info for a User based on the platform.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

platform Required String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/user/4/get-agent

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

platform: xxxxxxx

FortiNAC F 7.4.0 REST API 2924

Fortinet Inc.
Get /user/{id}/get-agent

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": "string"
}

FortiNAC F 7.4.0 REST API 2925

Fortinet Inc.
Post /user

Post /user

Description

Adds a new user record to the database.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 0,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",
"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",

FortiNAC F 7.4.0 REST API 2926

Fortinet Inc.
Post /user

"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-21T18:19:09.436Z",
"validForTime": "2024-02-21T18:19:09.436Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T18:19:09.436Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},

FortiNAC F 7.4.0 REST API 2927

Fortinet Inc.
Post /user

"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,

FortiNAC F 7.4.0 REST API 2928

Fortinet Inc.
Post /user

"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
}

FortiNAC F 7.4.0 REST API 2929

Fortinet Inc.
Post /user

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2930

Fortinet Inc.
Post /user/allow-hosts

Post /user/allow-hosts

Description

Sets the limit for number of hosts allowed per user.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/allowed-hosts

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body allowedHosts: 300

FortiNAC F 7.4.0 REST API 2931

Fortinet Inc.
Post /user/allow-hosts

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2932

Fortinet Inc.
Post /user/delete

Post /user/delete

Description

Deletes the user record or records supplied, if they are not currently in use.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

FortiNAC F 7.4.0 REST API 2933

Fortinet Inc.
Post /user/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2934

Fortinet Inc.
Post /user/disable

Post /user/disable

Description

Disables the User that matches the supplied DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body userID: "guest-access"

FortiNAC F 7.4.0 REST API 2935

Fortinet Inc.
Post /user/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2936

Fortinet Inc.
Post /user/{id}

Post /user/{id}

Description

Updates an existing User record in the database.

Request Parameter

Id, the user record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"landscape": 0,
"id": 3,
"role": "string",
"directoryPolicyValue": "string",
"firstName": "string",
"lastName": "string",
"dn": "string",
"position": "string",

FortiNAC F 7.4.0 REST API 2937

Fortinet Inc.
Post /user/{id}

"email": "string",
"state": "string",
"userID": "string",
"password": "string",
"status": 0,
"notes": "string",
"language": "string",
"country": "string",
"version": 0,
"packedVersion": 0,
"creationTime": "2024-02-21T18:19:09.436Z",
"validForTime": "2024-02-21T18:19:09.436Z",
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": "string",
"city": "string",
"mailState": "string",
"zipCode": "string",
"phone": "string",
"organization": "string",
"organizationalUnit": "string",
"type": "string",
"attributes": [
{
"version": 0,
"name": "string",
"value": {}
}
],
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": "string",
"mobileProvider": "string",
"ncmPropagateHosts": true,
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T18:19:09.436Z",
"isApiAdmin": true,
"apiAccessToken": "string",
"trustedHosts": "string",
"guestContractor": true,
"locale": {
"script": "string",
"country": "string",
"variant": "string",
"extensionKeys": [
"string"
],
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"iso3Language": "string",

FortiNAC F 7.4.0 REST API 2938

Fortinet Inc.
Post /user/{id}

"iso3Country": "string",
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"displayName": "string",
"language": "string"
},
"adminUser": true,
"validTime": 0,
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"addAuditSummary": "string",
"currentEnvironment": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deleteHostsUponExpiration": true,
"iconType": "string",
"disabled": true,
"directoryDisabled": true,
"apiAdmin": true,
"superUser": true,
"validForTimeMS": 0,
"passwordFromRaw": "string",
"userAdministrator": true,
"userOperator": true,
"userHelpDesk": true,
"userAdministrative": true,
"hashedPassword": "string",
"maxAllowedHosts": 0,
"creationEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"destroyEvent": {
"landscape": 0,
"id": 0,

FortiNAC F 7.4.0 REST API 2939

Fortinet Inc.
Post /user/{id}

"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"establishedEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"lostEvent": {
"landscape": 0,
"id": 0,
"state": "string",
"name": "string",
"elementType": "string",
"elementID": 0,
"elementName": "string",
"message": "string",
"timeOfEvent": "2024-02-21T18:19:09.436Z",
"version": 0,
"log": true,
"time": 0,
"eventFormatString": "string",
"empty": true
},
"name": "string"
}

FortiNAC F 7.4.0 REST API 2940

Fortinet Inc.
Post /user/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2941

Fortinet Inc.
Post /user/enable

Post /user/enable

Description

Enables the User that matches the supplied DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body userID: "guest-access"

FortiNAC F 7.4.0 REST API 2942

Fortinet Inc.
Post /user/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2943

Fortinet Inc.
Post /user/{id}/disable

Post /user/{id}/disable

Description

Disables the User that matches the supplied DBID.

Request Parameter

Id, the user record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/4/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2944

Fortinet Inc.
Post /user/{id}/disable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2945

Fortinet Inc.
Post /user/{id}/enable

Post /user/{id}/enable

Description

Enables the User that matches the supplied DBID.

Request Parameter

Id, the user record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/4/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2946

Fortinet Inc.
Post /user/{id}/enable

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2947

Fortinet Inc.
Post /user/set-role

Post /user/set-role

Description

Sets the Role for a list of users.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

role Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/set-role

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 4

role: "Guest"

FortiNAC F 7.4.0 REST API 2948

Fortinet Inc.
Post /user/set-role

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2949

Fortinet Inc.
Post /user/set-profile

Post /user/set-profile

Description

Sets the specified Admin Profile for the supplied set of Admin Users.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

profileID Required Integer

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/set-profile

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body profileID: 0

id:4

FortiNAC F 7.4.0 REST API 2950

Fortinet Inc.
Post /user/set-profile

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2951

Fortinet Inc.
Post /user/set-password

Post /user/set-password

Description

Sets the password of a local user account.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

userID Required String

password Required String

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/set-password

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body userID: "guest-access"

password:xxxxxxxx

FortiNAC F 7.4.0 REST API 2952

Fortinet Inc.
Post /user/set-password

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2953

Fortinet Inc.
Post /user/{id}/delete

Post /user/{id}/delete

Description

Deletes the user record or records supplied, if they are not currently in use.

Request Parameter

Id, the user record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/user/4/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2954

Fortinet Inc.
Post /user/{id}/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2955

Fortinet Inc.
Delete /user/{id}

Delete /user/{id}

Description

Deletes the user record supplied, if it is not currently in use.

Request Parameter

Id, the user record DBID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/user/3

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2956

Fortinet Inc.
Delete /user/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2957

Fortinet Inc.
Vulnerability Scanner

Vulnerability Scanner

FortiNAC F 7.4.0 REST API 2958

Fortinet Inc.
Get /settings/integration/vulnerability-scanner

Get /settings/integration/vulnerability-scanner

Description

Returns a list of vulnerability scanner records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2959

Fortinet Inc.
Get /settings/integration/vulnerability-scanner

Sample Response

FortiNAC F 7.4.0 REST API 2960

Fortinet Inc.
Get /settings/integration/vulnerability-scanner

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T22:49:57.275Z",
"vendor": "string",
"name": "string",
"request": "string",
"password": [
"string"
],
"identifier": "string",
"pluginName": "string",
"poll": true,
"scans": [
{
"dbid": 0,
"scanId": "string",
"uuid": "string",
"scannerDevice": "string",
"name": "string",
"status": "string",
"launchable": true,
"lastModified": "2024-02-21T22:49:57.275Z",
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"info": 0,
"profile": "string",
"startTime": "2024-02-21T22:49:57.275Z",
"type": "string",
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T22:49:57.275Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"pollInterval": 0,
"lastPoll": "2024-02-21T22:49:57.275Z",
"lastSuccessfulPoll": "2024-02-21T22:49:57.275Z",
"createDate": "2024-02-21T22:49:57.275Z",
"applianceName": "string",
"secretKey": "string",
"accessKey": "string",
"authenticationType": "string",
"userID": "string",
FortiNAC F"dbid":
7.4.0 REST
0, API 2961
Fortinet Inc.
"yamsEventTag": "string",
"auditObj": {
"user": "string",
Get /settings/integration/vulnerability-scanner/{id}

Get /settings/integration/vulnerability-scanner/{id}

Description

Returns a list of vulnerability scanner records matching the supplied filter.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/1

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2962

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}

Sample Response

FortiNAC F 7.4.0 REST API 2963

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-21T22:49:57.275Z",
"vendor": "string",
"name": "string",
"request": "string",
"password": [
"string"
],
"identifier": "string",
"pluginName": "string",
"poll": true,
"scans": [
{
"dbid": 0,
"scanId": "string",
"uuid": "string",
"scannerDevice": "string",
"name": "string",
"status": "string",
"launchable": true,
"lastModified": "2024-02-21T22:49:57.275Z",
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"info": 0,
"profile": "string",
"startTime": "2024-02-21T22:49:57.275Z",
"type": "string",
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T22:49:57.275Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"pollInterval": 0,
"lastPoll": "2024-02-21T22:49:57.275Z",
"lastSuccessfulPoll": "2024-02-21T22:49:57.275Z",
"createDate": "2024-02-21T22:49:57.275Z",
"applianceName": "string",
"secretKey": "string",
"accessKey": "string",
"authenticationType": "string",
"userID": "string",
FortiNAC F"dbid":
7.4.0 REST
0, API 2964
Fortinet Inc.
"yamsEventTag": "string",
"auditObj": {
"user": "string",
Get /settings/integration/vulnerability-scanner/{id}/scans

Get /settings/integration/vulnerability-scanner/{id}/scans

Description

Returns the scan names read from the connected vulnerability scanner based on the provided id.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

vendor Optional String

userID Optional String

requestStr Optional String

vulnPW Optional String

FortiNAC F 7.4.0 REST API 2965

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}/scans

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/2/scans

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"deletedScans": [
"string"
],
"scans": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2966

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}/qualys-appliances

Get /settings/integration/vulnerability-scanner/{id}/qualys-
appliances

Description

Returns the map of appliance names read from a Qualys vulnerability scanner for the provided id.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Integer

vendor Optional String

userID Optional String

requestStr Optional String

vulnPW Optional String

FortiNAC F 7.4.0 REST API 2967

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}/qualys-appliances

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/2/qualys-appliances

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Sample Response

{
"status": "string",
"errorMessage": "string",
"result": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}

FortiNAC F 7.4.0 REST API 2968

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}/usage

Get /settings/integration/vulnerability-scanner/{id}/usage

Description

Returns a list of records that reference this vulnerability scanner record.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/7/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2969

Fortinet Inc.
Get /settings/integration/vulnerability-scanner/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null,
"results": []
}

FortiNAC F 7.4.0 REST API 2970

Fortinet Inc.
Post /settings/integration/vulnerability-scanner

Post /settings/integration/vulnerability-scanner

Description

Creates a new vulnerability scanner record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

URL scanner

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request {
Body "vendor": "string",
"name": "string",
"request": "string",
"password": [
"string"
],
"identifier": "string",
"pluginName": "string",
"poll": true,
"scans": [
{
"dbid": 0,
"scanId": "string",
"uuid": "string",

FortiNAC F 7.4.0 REST API 2971

Fortinet Inc.
Post /settings/integration/vulnerability-scanner

"scannerDevice": "string",
"name": "string",
"status": "string",
"launchable": true,
"lastModified": "2024-02-21T23:10:48.006Z",
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"info": 0,
"profile": "string",
"startTime": "2024-02-21T23:10:48.006Z",
"type": "string",
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T23:10:48.006Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"pollInterval": 0,
"lastPoll": "2024-02-21T23:10:48.006Z",
"lastSuccessfulPoll": "2024-02-21T23:10:48.006Z",
"createDate": "2024-02-21T23:10:48.006Z",
"applianceName": "string",
"secretKey": "string",
"accessKey": "string",
"authenticationType": "string",
"userID": "string",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T23:10:48.006Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",

FortiNAC F 7.4.0 REST API 2972

Fortinet Inc.
Post /settings/integration/vulnerability-scanner

"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"passwordEncrypt": "string",
"passwordDecrypt": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null,
"result": []
}

FortiNAC F 7.4.0 REST API 2973

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/delete

Post /settings/integration/vulnerability-scanner/delete

Description

Deletes a list of vulnerability scanner records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:6

FortiNAC F 7.4.0 REST API 2974

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2975

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}

Post /settings/integration/vulnerability-scanner/{id}

Description

Updates an vulnerability scanner record.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

URL scanner/2

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Request {
Body "vendor": "string",
"name": "string",
"request": "string",
"password": [
"string"
],
"identifier": "string",

FortiNAC F 7.4.0 REST API 2976

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}

"pluginName": "string",
"poll": true,
"scans": [
{
"dbid": 0,
"scanId": "string",
"uuid": "string",
"scannerDevice": "string",
"name": "string",
"status": "string",
"launchable": true,
"lastModified": "2024-02-21T23:10:48.006Z",
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"info": 0,
"profile": "string",
"startTime": "2024-02-21T23:10:48.006Z",
"type": "string",
"auditString": "string",
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T23:10:48.006Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"pollInterval": 0,
"lastPoll": "2024-02-21T23:10:48.006Z",
"lastSuccessfulPoll": "2024-02-21T23:10:48.006Z",
"createDate": "2024-02-21T23:10:48.006Z",
"applianceName": "string",
"secretKey": "string",
"accessKey": "string",
"authenticationType": "string",
"userID": "string",
"dbid": 0,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-21T23:10:48.006Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"

FortiNAC F 7.4.0 REST API 2977

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}

},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
},
"auditObjectName": "string",
"auditObjectType": {
"auditTableName": "string",
"mysqlTableName": "string",
"idnameQuery": "string"
},
"passwordEncrypt": "string",
"passwordDecrypt": "string"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2978

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/delete

Post /settings/integration/vulnerability-scanner/{id}/delete

Description

Deletes a single vulnerability scanner record by ID.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/6/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2979

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2980

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/poll

Post /settings/integration/vulnerability-scanner/{id}/poll

Description

Polls the connection status of a vulnerability scanner to confirm communication based on the provided id.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

scanner/2/poll

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2981

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/poll

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 2982

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/test

Post /settings/integration/vulnerability-scanner/{id}/test

Description

Tests the connection to a supplied Vulnerability Scanner using supplied credentials to confirm successful
communication for the provided id.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

vendor Optional String

userID Optional String

requestStr Optional String

vulnPW Optional String

FortiNAC F 7.4.0 REST API 2983

Fortinet Inc.
Post /settings/integration/vulnerability-scanner/{id}/test

Sample Request

Request POST https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

URL scanner/2/test

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2984

Fortinet Inc.
Delete /settings/integration/vulnerability-scanner/{id}

Delete /settings/integration/vulnerability-scanner/{id}

Description

Deletes a single vulnerability scanner record by ID.

Request Parameter

Id, the vulnerability scanner record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request DELETE https://10.106.94.152:8443/api/v2/settings/integration/vulnerability-

URL scanner/2

Request Authorization: Bearer <Authorization_Token>

Header Content-Type: application/json

FortiNAC F 7.4.0 REST API 2985

Fortinet Inc.
Delete /settings/integration/vulnerability-scanner/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2986

Fortinet Inc.
Web Service Definition

Web Service Definition

FortiNAC F 7.4.0 REST API 2987

Fortinet Inc.
Get /settings/security/web-service-definition

Get /settings/security/web-service-definition

Description

Returns a list of Web Service Definition records matching the supplied filter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2988

Fortinet Inc.
Get /settings/security/web-service-definition

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": 1692985256000,
"lastChangeSummary": "",
"id": 1,
"serviceType": "REQUEST_URI",
"serviceMatcher": "/wpad.dat",
"serviceAction": "File",
"serviceTarget": "/wpad.dat",
"GUID": null,
"globalModifiedDate": 1692985256000
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 2989

Fortinet Inc.
Get /settings/security/web-service-definition/{id}

Get /settings/security/web-service-definition/{id}

Description

Returns a list of Web Service Definition records matching the supplied filter.

Request Parameter

Id, the Web Service Definition record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2990

Fortinet Inc.
Get /settings/security/web-service-definition/{id}

Sample Response

{
"status": "success",
"errorMessage": null,
"results": [
{
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": 1692985256000,
"lastChangeSummary": "",
"id": 1,
"serviceType": "REQUEST_URI",
"serviceMatcher": "/wpad.dat",
"serviceAction": "File",
"serviceTarget": "/wpad.dat",
"GUID": null,
"globalModifiedDate": 1692985256000
}
],
"filtered": 1,
"total": 1
}

FortiNAC F 7.4.0 REST API 2991

Fortinet Inc.
Get /settings/security/web-service-definition/{id}/usage

Get /settings/security/web-service-definition/{id}/usage

Description

Returns a list of records that reference this Web Service Definition record.

Request Parameter

Id, the Web Service Definition record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/1/usage

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2992

Fortinet Inc.
Get /settings/security/web-service-definition/{id}/usage

Sample Response

{
"status": "success",
"errorMessage": null
"results": []
}

FortiNAC F 7.4.0 REST API 2993

Fortinet Inc.
Post /settings/security/web-service-definition

Post /settings/security/web-service-definition

Description

Creates a new Web Service Definition record, updating instead if the supplied profile has a DBID of one that already
exists.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"globallyModifiedDateMilliseconds": 0,
"lastModifiedDateMilliseconds": 0,
"id": 0,
"serviceType": "string",
"serviceMatcher": "string",
"serviceAction": "string",
"serviceTarget": "string",
"gUID": 0,
"globalModifiedDate": "2024-02-22T19:17:32.521Z"
}

FortiNAC F 7.4.0 REST API 2994

Fortinet Inc.
Post /settings/security/web-service-definition

Sample Response

{
"status": "success",
"errorMessage": null,
"results": 0
}

FortiNAC F 7.4.0 REST API 2995

Fortinet Inc.
Post /settings/security/web-service-definition/delete

Post /settings/security/web-service-definition/delete

Description

Deletes a list of Web Service Definition records supplied under the id parameter.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id:13

FortiNAC F 7.4.0 REST API 2996

Fortinet Inc.
Post /settings/security/web-service-definition/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2997

Fortinet Inc.
Post /settings/security/web-service-definition/deploy

Post /settings/security/web-service-definition/deploy

Description

Writes the Web Service Definition into an Apache configuration.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/deploy

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 2998

Fortinet Inc.
Post /settings/security/web-service-definition/deploy

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 2999

Fortinet Inc.
Post /settings/security/web-service-definition/{id}

Post /settings/security/web-service-definition/{id}

Description

Updates a Web Service Definition record.

Request Parameter

Id, the Web Service Definition record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"globallyModifiedDateMilliseconds": 0,
"lastModifiedDateMilliseconds": 0,
"id": 1,
"serviceType": "string",
"serviceMatcher": "string",
"serviceAction": "string",
"serviceTarget": "string",
"gUID": 0,

FortiNAC F 7.4.0 REST API 3000

Fortinet Inc.
Post /settings/security/web-service-definition/{id}

"globalModifiedDate": "2024-02-22T19:17:32.521Z"
}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 3001

Fortinet Inc.
Post /settings/security/web-service-definition/{id}/delete

Post /settings/security/web-service-definition/{id}/delete

Description

Deletes a single Web Service Definition record by ID.

Request Parameter

Id, the Web Service Definition record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/14/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3002

Fortinet Inc.
Post /settings/security/web-service-definition/{id}/delete

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 3003

Fortinet Inc.
Delete /settings/security/web-service-definition/{id}

Delete /settings/security/web-service-definition/{id}

Description

Deletes a single Web Service Definition records by ID.

Request Parameter

Id, the Web Service Definition record ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/settings/security/web-

service-definition/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3004

Fortinet Inc.
Delete /settings/security/web-service-definition/{id}

Sample Response

{
"status": "success",
"errorMessage": null
}

FortiNAC F 7.4.0 REST API 3005

Fortinet Inc.
Winbind Configuration

Winbind Configuration

FortiNAC F 7.4.0 REST API 3006

Fortinet Inc.
Get /winbind/config

Get /winbind/config

Description

Returns all Winbind configuration objects.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

filter Optional Array

start Optional Integer

count Optional Integer

sortKey Optional String

sortDir Optional String

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3007

Fortinet Inc.
Get /winbind/config

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T21:33:55.083Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:33:55.083Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
]
}

FortiNAC F 7.4.0 REST API 3008

Fortinet Inc.
Get /winbind/config/all

Get /winbind/config/all

Description

Returns all Winbind configuration objects.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config/all

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3009

Fortinet Inc.
Get /winbind/config/all

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T21:33:55.083Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:33:55.083Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
]
}

FortiNAC F 7.4.0 REST API 3010

Fortinet Inc.
Get /winbind/config/global

Get /winbind/config/global

Description

Retrieves the global Winbind service data. (currently status & default local netbios name)

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config/global

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3011

Fortinet Inc.
Get /winbind/config/global

Sample Response

{
"status": "success",
"errorMessage": null,
"name": null,
"processEnabled": false,
"processRunning": false,
"isJoined": false,
"joinStatus": "",
"serviceStatus": "Winbind not configured",
"localNetbiosName": "pd-test",
"secondaryLocalNetbiosName": null
}

FortiNAC F 7.4.0 REST API 3012

Fortinet Inc.
Get /winbind/config/{id}

Get /winbind/config/{id}

Description

Returns Winbind configuration object by ID.

Request Parameter

Id, the Winbind configuration object Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3013

Fortinet Inc.
Get /winbind/config/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T21:33:55.083Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:33:55.083Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
]
}

FortiNAC F 7.4.0 REST API 3014

Fortinet Inc.
Get /winbind/config/log

Get /winbind/config/log

Description

Retrieves the current Winbind service log (/var/log/samba/log.winbind)

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

lines Optional Integer

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body lines: 100

FortiNAC F 7.4.0 REST API 3015

Fortinet Inc.
Get /winbind/config/log

Sample Response

{
"status": "success",
"errorMessage": null,
"log": "",
"systemdJournal": ""
}

FortiNAC F 7.4.0 REST API 3016

Fortinet Inc.
Get /winbind/config/status

Get /winbind/config/status

Description

Retrieves the current status for the Winbind service.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL GET https://10.106.94.152:8443/api/v2/winbind/config/status

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3017

Fortinet Inc.
Get /winbind/config/status

Sample Response

{
"status": "success",
"errorMessage": null,
"name": null,
"processEnabled": false,
"processRunning": false,
"isJoined": false,
"joinStatus": "",
"serviceStatus": "Winbind not configured"
}

FortiNAC F 7.4.0 REST API 3018

Fortinet Inc.
Post /winbind/config

Post /winbind/config

Description

Creates a Winbind configuration object.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",

FortiNAC F 7.4.0 REST API 3019

Fortinet Inc.
Post /winbind/config

"action": "string",
"timestamp": "2024-02-22T21:37:39.916Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T21:33:55.083Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:33:55.083Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
]
}

FortiNAC F 7.4.0 REST API 3020

Fortinet Inc.
Post /winbind/config/delete

Post /winbind/config/delete

Description

Deletes multiple winbind configuration objects by ID.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

id Required Array<Integer>

replaceWinbindId Required Integer

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config/delete

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body id: 5

replaceWinbindId: 3

FortiNAC F 7.4.0 REST API 3021

Fortinet Inc.
Post /winbind/config/delete

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 3022

Fortinet Inc.
Post /winbind/config/disable

Post /winbind/config/disable

Description

Disables the Winbind service for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config/disable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3023

Fortinet Inc.
Post /winbind/config/disable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 3024

Fortinet Inc.
Post /winbind/config/enable

Post /winbind/config/enable

Description

Enables the Winbind service for the system.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config/enable

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3025

Fortinet Inc.
Post /winbind/config/enable

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 3026

Fortinet Inc.
Post /winbind/config/{id}

Post /winbind/config/{id}

Description

Update an existing Winbind configuration object.

Request Parameter

Id, the Winbind configuration object Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body {
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,

FortiNAC F 7.4.0 REST API 3027

Fortinet Inc.
Post /winbind/config/{id}

"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:37:39.916Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}

FortiNAC F 7.4.0 REST API 3028

Fortinet Inc.
Post /winbind/config/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": [
{
"lastModifiedBy": "string",
"lastModifiedDate": "2024-02-22T21:33:55.083Z",
"dbid": 0,
"name": "string",
"workgroup": "string",
"localNetbios": "string",
"localNetbiosSecondary": "string",
"security": "string",
"realm": "string",
"logLevel": 0,
"passwordServer": "string",
"virtual": true,
"joined": true,
"logLevelStr": "string",
"valid": true,
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2024-02-22T21:33:55.083Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
]
}

FortiNAC F 7.4.0 REST API 3029

Fortinet Inc.
Post /winbind/config/joinDomain/{id}

Post /winbind/config/joinDomain/{id}

Description

Joins the domain for the Winbind instance specified by id.

Request Parameter

Id, the Winbind configuration object Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Request Body Parameters

Name Required Type

username Optional String

password Optional String

keytab Optional String

customOu Optional String

FortiNAC F 7.4.0 REST API 3030

Fortinet Inc.
Post /winbind/config/joinDomain/{id}

Sample Request

Request URL POST https://10.106.94.152:8443/api/v2/winbind/config/1

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body username: xxxxxx

password: xxxxxxxx
keytab: xxxxxxxx
customOu: xxxxxxx

Sample Response

{
"status": "string",
"errorMessage": "string"
}

FortiNAC F 7.4.0 REST API 3031

Fortinet Inc.
Delete /winbind/config/{id}

Delete /winbind/config/{id}

Description

Deletes Winbind configuration object by ID.

Request Parameter

Id, the Winbind configuration object Id.

Request Headers

Key Value Type Description

Authorization credential generated by

Authorization Bearer <Authorization Token> String
FortiNAC

Content-Type
application/json String
(option 1)

Content-Type
application/xml
(option 2)

Sample Request

Request URL DELETE https://10.106.94.152:8443/api/v2/winbind/config/2

Request Header Authorization: Bearer <Authorization_Token>

Content-Type: application/json

FortiNAC F 7.4.0 REST API 3032

Fortinet Inc.
Delete /winbind/config/{id}

Sample Response

{
"status": "string",
"errorMessage": "string",
"results": true
}

FortiNAC F 7.4.0 REST API 3033

Fortinet Inc.
Copyright© 2024 Fortinet, Inc. All rights reserved. Fortinet®, FortiGate®, FortiCare® and FortiGuard®, and certain other marks are registered trademarks of Fortinet, Inc., and
other Fortinet names herein may also be registered and/or common law trademarks of Fortinet. All other product or company names may be trademarks of their respective
owners. Performance and other metrics contained herein were attained in internal lab tests under ideal conditions, and actual performance and other results may vary. Network
variables, different network environments and other conditions may affect performance results. Nothing herein represents any binding commitment by Fortinet, and Fortinet
disclaims all warranties, whether express or implied, except to the extent Fortinet enters a binding written contract, signed by Fortinet’s Chief Legal Officer, with a purchaser that
expressly warrants that the identified product will perform according to certain expressly-identified performance metrics and, in such event, only the specific performance
metrics expressly identified in such binding written contract shall be binding on Fortinet. For absolute clarity, any such warranty will be limited to performance in the same ideal
conditions as in Fortinet’s internal lab tests. Fortinet disclaims in full any covenants, representations, and guarantees pursuant hereto, whether express or implied. Fortinet
reserves the right to change, modify, transfer, or otherwise revise this publication without notice, and the most current version of the publication shall be applicable.