-
Notifications
You must be signed in to change notification settings - Fork 0
/
ncm_api_v2.yaml
3866 lines (3866 loc) · 124 KB
/
ncm_api_v2.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
basePath: https://www.cradlepointecm.com/api/v2
swaggerVersion: '1.2'
apiVersion: v2
apis:
- path: "/accounts/"
operations:
- method: GET
summary: Get Accounts information
notes: "<p>This method gives a list of accounts with its information.</p><!--<p>
ECM also provides 'filter' parameter. Results can be filtered by field values.
Example:</p><pre>format=json&mac=10</pre><p>Fields from sub-resources can be
specified. Example:</p><pre>format=json&product.name=MBR1400</pre><p>Multiple
values can be matched:</p><pre>mac__in=003044123456,003044789012</pre>--><p>Example
URL</p><pre> https://www.cradlepointecm.com/api/v2/accounts/?id=1127&name=cradlepoint</pre>"
type: ''
nickname: accounts
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: account
description: Parent account
required: false
type: 'in: int<br />out: url'
paramType: query
- name: account__in
description: Contains filter for account
required: false
type: 'in: int<br />out: url'
paramType: query
- name: id
description: Object ID
required: false
type: int
paramType: query
- name: id__in
description: Contains filter for id
required: false
type: int
paramType: query
- name: name
description: Name of the account
required: false
type: string
paramType: query
- name: name__in
description: Contains filter for name
required: false
type: string
paramType: query
- name: expand
description: Specifies expanded data for a attribute
required: false
type: string
paramType: query
- path: "/accounts/{id}/"
operations:
- method: PUT
summary: Update an account
notes: "<p>This method updates an account for associated id</p>"
description: "<p>This operation updates an account.</p>"
group: account
type: ''
nickname: accounts
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: id
description: Object ID
required: true
type: int
paramType: path
- name: content
description: Add the Json
required: true
type: string
paramType: body
- path: "/accounts/"
operations:
- method: POST
summary: Create new sub-account
notes: This operation creates new sub-account
description: "<p>This operation creates new sub-account.</p>"
group: account
type: ''
nickname: accounts
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: content
description: Add the Json
required: true
type: string
paramType: body
- path: "/accounts/{id}/"
operations:
- method: DELETE
summary: Delete an account
notes: This method deletes an account with the associated id. <p><b>Note:</b>
The 'Try it out' button is removed for this example since the delete process
is not reversible. Once a delete occurs the data is gone forever.</p>
description: "<p>This operation deletes an account.</p>"
group: account
type: ''
nickname: accounts
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: id
description: Object ID
required: true
type: int
paramType: path
- path: "/alert_push_destinations/"
operations:
- method: GET
summary: Get information about alert_push_destinations
notes: "<p>This method retrieves information about your Alert Push Destinations.</p>"
type: ''
nickname: alert_push_destinations
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: destination_config_id
description: Unique ID of an Alert Push Destination
required: false
type: timeuuid
paramType: query
- path: "/alert_push_destinations/"
operations:
- method: POST
summary: Create an alert_push_destinations record
notes: This operation creates new Alert Push Destination
description: "<p>This operation creates a new Alert Push Destination.</p>"
group: alert_push_destinations
type: ''
nickname: alert_push_destinations
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: content
description: Json object containing any of the following fields; name, enabled,
endpoint, and authentication.
required: true
type: string
paramType: body
- path: "/alert_push_destinations/{destination_config_id}/"
operations:
- method: PATCH
summary: Update an alert_push_destinations record
notes: "<p>Use this method to update an Alert Push Destination matching the passed
in destination_config_id</p>"
description: "<p>This operation updates an Alert Push Destination.</p>"
group: alert_push_destinations
type: ''
nickname: alert_push_destinations
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: destination_config_id
description: Unique ID of an Alert Push Destination
required: true
type: timeuuid
paramType: path
- name: content
description: Json object containing the fields/values to update
required: true
type: string
paramType: body
- path: "/alert_push_destinations/{destination_config_id}/"
operations:
- method: DELETE
summary: Delete an alert_push_destinations record
notes: This method deletes an Alert Push Destination with the associated id. <p><b>Note:</b>
The 'Try it out' button is removed for this example since the delete process
is not reversible. Once a delete occurs the data is gone forever.</p>
description: "<p>This operation deletes an account.</p>"
group: alert_push_destinations
type: ''
nickname: alert_push_destinations
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: destination_config_id
description: Object ID of Alert Push Destination to delete
required: true
type: timeuuid
paramType: path
- path: "/activity_logs/"
operations:
- method: GET
summary: Get Activity Log information
notes: "<p>This method returns NCM activity log information.</p><p>Example URL</p><pre>
https://www.cradlepointecm.com/api/v2/activity_logs/</pre>"
type: ''
nickname: activities
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: action_timestamp__exact
description: The time (exact) when the action occurred
required: false
type: timestamp
paramType: query
- name: action_timestamp__lt
description: Less than filtering operator for when action occurred
required: false
type: timestamp
paramType: query
- name: action_timestamp__lte
description: Less than or equal filtering operator for when action occurred
required: false
type: timestamp
paramType: query
- name: action_timestamp__gt
description: Greater than filtering operator for when action occurred
required: false
type: timestamp
paramType: query
- name: action_timestamp__gte
description: Greater than or equal filtering operator for when action occurred
required: false
type: timestamp
paramType: query
- name: actor__type
description: Type of actor who took the action
required: false
type: string
enum:
- system
- legacy user
- api key
- router
- sso user
- login
- access point
paramType: query
- name: action__type
description: Type of action taken
required: false
type: string
enum:
- create
- delete
- update
- request
- report
- login
- logout
- register
- unregister
- activate
paramType: query
- name: object__type
description: Type of object the action was taken upon
required: false
type: string
enum:
- rome account
- legacy user
- group
- router
- schedule
- sso user
- sso account
- task
- api key
- net device
- notifier
- feature binding
- rome authorization
- sso authorizaion
- remote connection
- remote connection profile
- remote lan management
- access point
- network
paramType: query
- path: "/alert_rules/"
operations:
- method: GET
summary: Get information about alert_rules
notes: Use the GET method on this endpoint to retrieve alert_rules records. Use
the available filtering fields to narrow or broaden your search.
type: ''
nickname: alert_rules
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: alert_config_id
description: Unique ID of an Alert Rule
required: false
type: timeuuid
paramType: query
- name: account
description: Parent account
required: false
type: url
paramType: query
- name: schedule
description: Schedule for sending notifications
required: false
type: string
paramType: query
- name: associated_accounts
description: A list of account-identfier ints
required: false
type: int
paramType: query
- name: associated_groups
description: A list of group-identfier ints
required: false
type: int
paramType: query
- name: filter_criteria
description: Alert types to add to the Alert Rule
required: false
type: json
paramType: query
- name: email_destinations
description: Email dests (list of ints) used for email notifications
required: false
type: int
paramType: query
- name: http_destinations
description: HTTP dests (list of timeuuids) for push notifications
required: false
type: timeuuid
paramType: query
- name: updated_at
description: Last time an Alert Rule was modified
required: false
type: timestamp
paramType: query
- name: settings
description: Additional settings for PDP service-overage alerts
required: false
type: json
paramType: query
- path: "/alert_rules/"
operations:
- method: POST
summary: Create an alert_rules record
notes: Use the POST method on this endpoint to create a new alert_rules record.
Include the fields/values to add for the record in the 'Content' field as a
JSON object.
description: Use the POST method on this endpoint to create a new alert_rules
record. Include the fields/values to add for the record in the 'Content' field
as a JSON object.
group: alert_rules
type: ''
nickname: alert_rules
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: content
description: Json object containing any of the following fields; schedule, associated_accounts,
associated_groups, filter_criteria, http_destinations, and settings.
required: true
type: string
paramType: body
- path: "/alert_rules/{alert_config_id}/"
operations:
- method: PATCH
summary: Update an alert_rules record
notes: Use the PATCH method on this endpoint to update an alert_rules record.
Include the fields/values to update in the 'Content' field as a JSON object.
description: "<p>This operation updates an Alert Rule.</p>"
group: alert_rules
type: ''
nickname: alert_rules
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: alert_config_id
description: Unique ID of an Alert Rule
required: false
type: timeuuid
paramType: path
- name: content
description: Json object containing the fields/values to update. This can contain
any of the fields allowed in POST operations
required: true
type: string
paramType: body
- path: "/alert_rules/{alert_config_id}/"
operations:
- method: DELETE
summary: Delete an alert_rules record
notes: Use the DELETE method on this endpoint to delete a alert_rules record.
This method requires the ID of the alert_rules record to delete. Performing
a DELETE action removes the record from NetCloud and can't be reversed.
description: "<p>This operation deletes an account.</p>"
group: alert_rules
type: ''
nickname: alert_rules
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: alert_config_id
description: Object ID of Alert Rule to delete
required: true
type: timeuuid
paramType: path
- path: "/alerts/"
operations:
- method: GET
summary: Get information about alerts
notes: Use the GET method on this endpoint to retrieve alerts records. Use the
available filtering fields to narrow or broaden your search.
description: "<p>This method gives alert information with associated id.</p>"
group: alerts
type: ''
nickname: alerts
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: account
description: Account this alert is related to, or null if the router field has
a value
required: false
type: 'in: int<br />out: url'
paramType: query
- name: created_at
description: Time the alert record was created in NCM
required: false
type: timestamp
paramType: query
- name: created_at_timeuuid
description: A unique ID associated with the created_at timestamp. Ordering
by the ID is equivalent to time ordering. This field can identify a specific
record or be used for paging.
required: false
type: timeuuid
paramType: query
- name: detected_at
description: Time the alert was detected
required: false
type: timestamp
paramType: query
- name: friendly_info
description: Human-readable description of the alert
required: false
type: string
paramType: query
- name: info
description: Alert-type specific information, in JSON format
required: false
type: string
paramType: body
- name: router
description: Device this alert is related to, or null if the account field has
a value
required: false
type: 'in: int<br />out: url'
paramType: query
- name: type
description: Specifies the type of the alert
required: false
type: string
paramType: query
- path: "/batteries/"
operations:
- method: GET
summary: Get information about batteries
notes: Use the GET method on this endpoint to retrieve batteries records.
type: ''
nickname: batteries
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: router
description: ID of E100-series router to query for battery information
required: true
type: int
paramType: query
- path: "/configuration_managers/"
operations:
- method: GET
summary: Get information about configuration_managers
notes: Use the GET method on this endpoint to retrieve configuration_managers
records. Use the available filtering fields to narrow or broaden your search.
nickname: configuration_managers
group: configuration_managers
type: ''
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: account
description: Account that contains the configuration_managers record
required: false
type: 'in: int<br />out: url'
paramType: query
- name: account__in
description: Filter for account contains - a comma-separated list of account
IDs
required: false
type: 'in: int<br />out: url'
paramType: query
- name: id
description: ID of a configuration_managers record
required: false
type: int
paramType: query
- name: id__in
description: Filter for ID contains - a comma-separated list of configuration_managers
record IDs
required: false
type: int
paramType: query
- name: router
description: Router ID
required: false
type: 'in: int<br />out: url'
paramType: query
- name: router__in
description: Filter for router ID contains - a comma-separated list of router-record
IDs
required: false
type: 'in: int<br />out: url'
paramType: query
- name: synched
description: True if device configuration is synced
required: false
type: boolean
paramType: query
- name: suspended
description: True if device configuration sync is paused
required: false
type: boolean
paramType: query
- name: expand
description: Specifies that the returned value for the passed in attribute be
expanded in the response body
required: false
type: string
enum:
- account
- router
paramType: query
- path: "/configuration_managers/{id}/"
operations:
- method: PUT
summary: Update a configuration_managers record
notes: Use the PUT method on this endpoint to update a configuration_managers
record. Include the fields/values to update in the 'Content' field as a JSON
object.
description: Update a configuration_managers record, by ID
group: configuration_managers
type: ''
nickname: configuration_managers
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: id
description: The ID of the configuration_managers record to modify
required: true
type: int
paramType: path
- name: content
description: JSON describing the configuration_managers record field(s) to update
required: true
type: string
paramType: body
- path: "/configuration_managers/{id}/"
operations:
- method: PATCH
summary: Update a configuration_managers record
notes: Use the PATCH method on this endpoint to update a configuration_managers
record. Include the fields/values to update in the 'Content' field as a JSON
object.
description: "<p>This method updates a configuration_managers for associated id.</p>"
group: configuration_managers
type: ''
nickname: configuration_managers
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: id
description: The ID of the configuration_managers record to modify
required: true
type: int
paramType: path
- name: content
description: JSON describing the configuration_managers record field(s) to update
required: true
type: string
paramType: body
- path: "/device_app_bindings/"
operations:
- method: GET
summary: Get information about device_app_bindings
notes: Use the GET method on this endpoint to retrieve device_app_bindings records.
Use the available filtering fields to narrow or broaden your search.
description: Use the GET method on this endpoint to retrieve device_app_bindings
records. Use the available filtering fields to narrow or broaden your search.
group: device_app_bindings
type: ''
nickname: device_app_bindings
parameters:
- name: X-ECM-API-ID
description: "<strong>ECM API app Id</strong>"
type: string
paramType: header
required: true
- name: X-ECM-API-KEY
description: "<strong>ECM API app key</strong>"
type: string
paramType: header
required: true
- name: X-CP-API-ID
description: "<strong>Cradlepoint API app Id</strong>"
type: string
paramType: header
threescale_name: app_ids
required: true
- name: X-CP-API-KEY
description: "<strong>Cradlepoint API access key</strong>"
type: string
paramType: header
threescale_name: app_keys
required: true
- name: account
description: Account that owns the object
required: false
type: 'in: int<br />out: url'
paramType: query
- name: account__in
description: Filter for account contains - a comma-separated list of account
IDs
required: false
type: 'in: int<br />out: url'
paramType: query
- name: group
description: Group that owns the object
required: false
type: 'in: int<br />out: url'
paramType: query
- name: group__in
description: Filter for group contains - a comma-separated list of group IDs