-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathswagger.yaml
1404 lines (1387 loc) · 40.3 KB
/
swagger.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
swagger: '2.0'
info:
version: '1.0'
title: "Webhook Relay"
description: |
# Introduction
Fast, secure tunnels to your internal networks. [Webhook Relay](https://webhookrelay.com) allows you to expose your localhost
or any other server in private network to the public internet without configuring port forwarding
or firewalls.
This API is documented in **Swagger format**. Webhook Relay allows to dynamically configure your tunnels and webhook forwarding and request/response
transformation using serverless functions.
# Available authentication methods
Webhook Relay offers three forms of authentication:
- **Basic Auth** - only available for non-OAuth accounts. Use your username and password.
- **API Key** - available for all accounts, token pairs can be generated [here](https://my.webhookrelay.com/tokens)
- **JWT** - mainly used by the [admin dashboard](https://my.webhookrelay.com) with a 'Authorization Bearer: token'
You can find Swagger and OpenAPI spec files here: [https://github.com/webhookrelay/swagger-webhookrelay](https://github.com/webhookrelay/swagger-webhookrelay).
termsOfService: "https://webhookrelay.com/tos/"
contact:
email: "[email protected]"
externalDocs:
description: Find out more in the official documentation.
url: 'https://webhookrelay.com/v1/guide/'
host: my.webhookrelay.com
basePath: /
schemes:
- "https"
consumes:
- application/json
produces:
- application/json
tags:
- name: Tokens
description: Token key & secret pairs are used to authenticate your API calls or for agents to subscribe to webhook forwarding or open tunnels.
- name: Buckets
description: Input and output grouping. Bucket allows to have multiple endpoints for the same destination or multiple destinations for fan-out style webhook forwarding.
- name: Outputs
description: Outputs are destinations, where your webhooks will be forwarded. Public destinations do not require agents to be running. Internal outputs will not work without an agent.
- name: Inputs
description: "Inputs are your public endpoints. Each input serves as an inbox that you can supply to your webhooks producer (ie: Github, Docker, IFTTT)"
- name: Logs
description: "Webhook logs hold the status of received and forwarded webhooks. You can use this API group to resend webhooks to one or more destinations"
- name: Functions
description: |
Webhook Relay Functions provide an easy way to extract values from webhooks and transform HTTP
requests before passing them to their final destination. Function can be reused by any number
of Inputs and/or Outputs. Since user doesn’t have to run a server, this type of function service
is also known as FaaS (Function as a Service) or Serverless.
Read more about functions here: https://webhookrelay.com/v1/guide/functions.
Basic function examples can be found here: https://webhookrelay.com/v1/examples/manipulating-request-body.
- name: Tunnels
description: |
Tunnels allow remote access to internal web services such as local Wordpress, Jekyll or Hexo. Recommended `crypto` options are `flexible` or `tls-pass-through`.
x-tagGroups:
- name: Authentication
tags:
- Tokens
- name: Webhook Forwarding
tags:
- Buckets
- Outputs
- Inputs
- Logs
- Functions
- name: Tunneling
tags:
- Tunnels
paths:
/v1/tunnels:
x-summary: List and create tunnels
get:
tags:
- "Tunnels"
summary: List All Tunnels
responses:
200:
description: Successful Response
schema:
type: array
items:
$ref: '#/definitions/Tunnel'
examples:
application/json:
- id: 'b3237483-e96e-4f3a-905c-0d9603d66c1f'
created_at: 1534409264
updated_at: 1534409264
name: 'tunnel-x'
destination: 'http://localhost:4000'
host: 'tunnelx.webrelay.io'
post:
tags:
- "Tunnels"
description: >-
You may create your own tunnel using this action. It takes a JSON
object containing a tunnel request with a specified destination. Paid plans
have an option to specify either encryption, subdomain or full domain.
summary: Create a New Tunnel
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Tunnel'
responses:
201:
description: ''
schema:
$ref: '#/definitions/Tunnel'
examples:
description: "Create a tunnel with a custom subdomain"
application/json:
id: b3237483-e96e-4f3a-905c-0d9603d66c1f
created_at: 1534409264
updated_at: 1534409264
name: 'tunnel-x'
destination: 'http://localhost:4000'
host: 'tunnelx.webrelay.io'
400:
description: "Invalid tunnel request supplied"
/v1/tunnels/{tunnelID}:
x-summary: Get, update and delete tunnels
parameters:
- name: "tunnelID"
in: "path"
description: "ID of tunnel to return"
required: true
type: "string"
get:
tags:
- "Tunnels"
summary: Get Tunnel Details
responses:
200:
description: Successful Response
schema:
$ref: "#/definitions/Tunnel"
examples:
application/json:
created_at: 1534409264
updated_at: 1534409264
id: b3237483-e96e-4f3a-905c-0d9603d66c1f
destination: http://localhost:8090
name: tunnel
group: ''
addr: ''
host: tunnelx.webrelay.io
mode: active
protocol: http
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
description: ''
features:
auth:
created_at: 1534409264
updated_at: 1534409264
id: eb3fbc49-0713-48b1-8971-a7c4a9c64dfb
type: none
agent_id: ''
ingress_rules:
crypto: 'off'
404:
description: Tunnel not found
put:
tags:
- "Tunnels"
summary: Update Tunnel Details
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Tunnel'
responses:
200:
description: Successful Response
schema:
$ref: "#/definitions/Tunnel"
examples:
application/json:
created_at: 1534409264
updated_at: 1534409264
id: b3237483-e96e-4f3a-905c-0d9603d66c1f
destination: http://localhost:8090
name: tunnel
group: ''
addr: ''
host: tunnelx.webrelay.io
mode: active
protocol: http
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
description: ''
features:
auth:
created_at: 1534409264
updated_at: 1534409264
id: eb3fbc49-0713-48b1-8971-a7c4a9c64dfb
type: none
agent_id: ''
ingress_rules:
crypto: 'off'
404:
description: Tunnel not found
400:
description: Bad request (check response message)
delete:
tags:
- "Tunnels"
summary: Delete Tunnel
responses:
200:
description: Successful Response
404:
description: Tunnel not found
# Token configuration
/v1/tokens:
x-summary: List and create tunnels
get:
tags:
- "Tokens"
summary: List All Authentication Tokens
responses:
200:
description: Successful Response
schema:
type: array
items:
$ref: '#/definitions/Token'
examples:
application/json:
- created_at: 1535232797
updated_at: 1540394529
last_login: 3 days ago
id: 0a8dd8b4-aaaa-rrrr-dddd-ccc860e3005a
description: linux cli
scopes:
buckets: []
tunnels: []
active: true
api_access: enabled
post:
tags:
- "Tokens"
summary: Create a New Authentication Token
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Token'
responses:
201:
description: 'Create a new token'
schema:
$ref: '#/definitions/TokenCreateResponse'
examples:
application/json:
key: cc58c9ea-5fa7-466e-91dc-5c08d0b1127c
secret: very-secret
400:
description: ''
/v1/tokens/{tokenID}:
x-summary: Update and delete tokens
parameters:
- name: "tokenID"
in: "path"
description: "ID of token"
required: true
type: "string"
put:
tags:
- "Tokens"
summary: Update Token Details
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Token'
responses:
200:
description: Successful Response
schema:
$ref: "#/definitions/Token"
examples:
application/json:
application/json:
created_at: 1535365683
updated_at: 1536161359
id: cc58c9ea-5fa7-466e-91dc-5c08d0b1127c
description: ''
scopes:
buckets: []
tunnels:
- foo
- bar
- faa
active: true
api_access: "enabled"
404:
description: Tunnel not found
400:
description: Bad request (check response message)
delete:
tags:
- "Tokens"
summary: Delete Token
responses:
200:
description: Successful Response
404:
description: Token not found
# Bucket configuration
/v1/buckets:
x-summary: List and create buckets
get:
tags:
- "Buckets"
summary: List All Buckets
responses:
200:
description: Successful Response
schema:
type: array
items:
$ref: '#/definitions/Bucket'
examples:
examples:
application/json:
- created_at: 1496610194
updated_at: 1532192772
id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
name: webhook-demo
description: auto-created input for http://localhost:8090/webhook
suspended: false
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
auth:
created_at: -62135596800
updated_at: -62135596800
id: ''
type: none
inputs:
- created_at: 1496610195
updated_at: 1496610195
id: 5e722a5e-f3d9-4eec-9e9f-79f1158e4b10
name: ingress for http://localhost:8090/webhook
bucket_id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
description: auto-created input for http://localhost:8090/webhook
created_by: ''
outputs:
- created_at: 1496610196
updated_at: 1496610196
id: 3ec1899c-7069-4f55-88c6-5d8f5da4fa30
name: http://localhost:8090/webhook
bucket_id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
destination: http://localhost:8090/webhook
internal: true
description: auto-created output for http://localhost:8090/webhook
created_by: ''
post:
tags:
- "Buckets"
description: >-
You may create your own bucket using this action. It takes a JSON
object containing a bucket request. Once bucket is created, it gets
assigned a default input to accept webhooks but you will still have to
create a new output to give it a destination.
summary: Create a New Bucket
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/BucketRequest'
responses:
201:
description: ''
schema:
$ref: '#/definitions/Bucket'
400:
description: "Invalid bucket request supplied"
/v1/buckets/{bucketID}:
x-summary: Get and delete buckets
parameters:
- name: "bucketID"
in: "path"
description: "ID of a bucket to return"
required: true
type: "string"
put:
tags:
- "Buckets"
description: >-
Update bucket.
summary: Update Bucket
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Bucket'
responses:
200:
description: 'Bucket updated'
schema:
$ref: '#/definitions/Bucket'
400:
description: "Invalid bucket update request supplied"
404:
description: Bucket not found
get:
tags:
- "Buckets"
summary: Get Bucket Details
responses:
200:
description: Successful Response
schema:
$ref: "#/definitions/Bucket"
examples:
application/json:
created_at: 1496610194
updated_at: 1532192772
id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
name: webhook-demo
description: auto-created input for http://localhost:8090/webhook
suspended: false
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
auth:
created_at: -62135596800
updated_at: -62135596800
id: ''
type: none
inputs:
- created_at: 1496610195
updated_at: 1496610195
id: 5e722a5e-f3d9-4eec-9e9f-79f1158e4b10
name: ingress for http://localhost:8090/webhook
bucket_id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
description: auto-created input for http://localhost:8090/webhook
created_by: ''
outputs:
- created_at: 1496610196
updated_at: 1496610196
id: 3ec1899c-7069-4f55-88c6-5d8f5da4fa30
name: http://localhost:8090/webhook
bucket_id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
destination: http://localhost:8090/webhook
internal: true
description: auto-created output for http://localhost:8090/webhook
created_by: ''
404:
description: Bucket not found
delete:
tags:
- "Buckets"
summary: Delete Bucket
responses:
200:
description: Successful Response
404:
description: Bucket not found
/v1/buckets/{bucketID}/inputs:
x-summary: Manage bucket inputs
parameters:
- name: "bucketID"
in: "path"
description: "ID of a bucket to create input in"
required: true
type: "string"
post:
tags:
- "Inputs"
description: >-
Create one or more inputs for the bucket to get unique public endpoints.
summary: Create a New Input
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Input'
responses:
201:
description: ''
schema:
$ref: '#/definitions/Input'
400:
description: "Invalid input request supplied"
/v1/buckets/{bucketID}/inputs/{inputID}:
x-summary: Manage bucket inputs
parameters:
- name: "bucketID"
in: "path"
description: "ID of a bucket to create input in"
required: true
type: "string"
- name: "inputID"
in: "path"
description: "ID of an input to delete"
required: true
type: "string"
put:
tags:
- "Inputs"
description: >-
Update input endpoint response code, body or headers.
summary: Update Input
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Input'
responses:
200:
description: 'Input updated'
schema:
$ref: '#/definitions/Input'
400:
description: "Invalid input request supplied"
delete:
tags:
- "Inputs"
description: >-
Delete input. Once input is deleted, you will not be able to recreate a new input with the same ID.
summary: Delete Input
responses:
200:
description: ''
404:
description: "Input or Bucket not found"
# Outputs
/v1/buckets/{bucketID}/outputs:
x-summary: Manage bucket outputs
parameters:
- name: "bucketID"
in: "path"
description: "ID of a bucket to create output in"
required: true
type: "string"
post:
tags:
- "Outputs"
description: >-
Create one or more outputs for the bucket to start forwarding webhooks to those destinations.
summary: Create a New Output
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Output'
responses:
201:
description: ''
schema:
$ref: '#/definitions/Output'
400:
description: "Invalid output request supplied"
/v1/buckets/{bucketID}/outputs/{outputID}:
x-summary: Manage bucket outputs
parameters:
- name: "bucketID"
in: "path"
description: "ID of a bucket to create input in"
required: true
type: "string"
- name: "outputID"
in: "path"
description: "ID of an output to manage"
required: true
type: "string"
put:
tags:
- "Outputs"
description: >-
Update output destination or make it public/internal.
summary: Update Output
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Output'
responses:
200:
description: 'Output updated'
schema:
$ref: '#/definitions/Output'
400:
description: "Invalid output request supplied"
delete:
tags:
- "Outputs"
summary: Delete Output
responses:
200:
description: ''
404:
description: "Output or Bucket not found"
# ------------------------ functions -------------------------
/v1/functions:
x-summary: List and create functions
get:
tags:
- "Functions"
summary: List All Functions
responses:
200:
description: Successful Response
schema:
type: array
items:
$ref: '#/definitions/Function'
examples:
examples:
application/json:
- created: 1496610194
updated: 1532192772
id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
name: lightspeedhq_to_webshipper
driver: "lua"
payload_size: 500814
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
post:
tags:
- "Functions"
description: >-
You may create your own functions using this action. It takes a JSON
object containing a function request. Once function is created, you can
assign it based on its ID to bucket's input and/or output.
summary: Create a New Function
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/FunctionRequest'
responses:
201:
description: ''
schema:
$ref: '#/definitions/Function'
400:
description: "Invalid function request supplied"
/v1/functions/{functionID}:
x-summary: Get and delete functions
parameters:
- name: "functionID"
in: "path"
description: "ID of a function to return"
required: true
type: "string"
put:
tags:
- "Functions"
description: >-
Update function.
summary: Update Function
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/FunctionRequest'
responses:
200:
description: 'Function updated'
schema:
$ref: '#/definitions/Function'
400:
description: "Invalid function update request supplied"
404:
description: Function not found
get:
tags:
- "Functions"
summary: Get Function Details
responses:
200:
description: Successful Response
schema:
$ref: "#/definitions/Function"
examples:
application/json:
- created: 1496610194
updated: 1532192772
id: 339ed2e3-70cf-4a81-8db8-e95a9251155d
name: lightspeedhq_to_webshipper
driver: "lua"
payload: "<base64 encoded function body>"
payload_size: 500814
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
404:
description: Function not found
delete:
tags:
- "Functions"
summary: Delete Function
responses:
200:
description: Successful Response
404:
description: Function not found
# --------------------------- logs ---------------------------
/v1/logs:
get:
tags:
- Logs
summary: List logs
parameters:
- in: query
name: from
type: string
description: "YYYY-MM-DD date from when the logs should be returned, for example '2020-01-01'"
- in: query
name: to
type: string
description: "YYYY-MM-DD last day till when the logs should be returned, for example '2020-01-02' (includes the last day)"
- in: query
name: bucket
type: string
description: "Optional bucket ID for filtering logs"
- in: query
name: limit
type: integer
description: "Limit of the logs to return"
- in: query
name: offset
type: integer
description: "Offset of the logs when querying"
- in: query
name: status
type: string
enum: [status, failed, stalled, received, rejected]
description: "Webhook log status"
responses:
200:
description: Successful Response
schema:
$ref: '#/definitions/LogsResponse'
/v1/logs/{logID}/action:
post:
tags:
- Logs
description: You may resend log to one or more destinations
summary: Resend log
parameters:
- name: "logID"
in: "path"
required: true
description: "ID of a log"
type: "string"
- name: body
in: body
required: true
schema:
$ref: '#/definitions/LogAction'
responses:
200:
description: ""
schema:
$ref: '#/definitions/Response'
400:
description: Invalid request
# Domain reservation
/v1/domains:
get:
tags:
- Domains
summary: List domain reservations
responses:
200:
description: Successful Response
schema:
$ref: '#/definitions/Domain'
post:
tags:
- Domains
description: Reserve a domain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Domain'
responses:
201:
description: ""
schema:
$ref: '#/definitions/Response'
400:
description: Invalid request
412:
description: Domain already taken
451:
description: Your subscription doesn't include domain reservations
500:
description: Internal server error
/v1/domains/{domainID}:
x-summary: Get and delete buckets
parameters:
- name: "domainID"
in: "path"
description: "ID of a domain to delete"
required: true
type: "string"
delete:
tags:
- "Domains"
summary: Delete a domain reservation
responses:
200:
description: Successful Response
404:
description: Domain reservation not found
412:
description: Can't delete domain reservation, it's in use by a tunnel or an input with a custom domain
# -----------------------------------------------------------------
#
# DEFINITIONS
#
#------------------------------------------------------------------
definitions:
# --------------------------- tunnels ---------------------------
Tunnel:
title: Tunnel
type: object
properties:
id:
type: string
readOnly: true
created_at:
type: integer
readOnly: true
updated_at:
type: integer
readOnly: true
destination:
type: string
name:
type: string
region:
type: string
enum:
- ""
- us-west
- eu
- au
description: "Tunnel region"
example: "au"
group:
type: string
description: Groups allow agents to subscribe to one or more tunnels
host:
type: string
protocol:
type: string
description:
type: string
auth:
type: object
$ref: '#/definitions/TunnelAuth'
crypto:
enum:
- "off"
- flexible
- full
- full-strict
- tls-pass-through
type: string
description: Tunnel encryption type
example: flexible
example:
created_at: 1534409264
updated_at: 1534409264
id: b3237483-e96e-4f3a-905c-0d9603d66c1f
destination: http://localhost:8090
name: tunnel
group: ''
addr: ''
host: tunnelx.webrelay.io
protocol: http
account_id: bd7e1dfc-54c8-408c-a885-7498bf1d8522
description: ''
features:
auth:
created_at: 1534409264
updated_at: 1534409264
id: eb3fbc49-0713-48b1-8971-a7c4a9c64dfb
type: none
agent_id: ''
ingress_rules:
crypto: 'off'
TunnelAuth:
title: Tunnel Authentication
type: object
properties:
id:
type: string
readOnly: true
created_at:
type: integer
readOnly: true
updated_at:
type: integer
readOnly: true
type:
type: string
username:
type: string
password:
type: string
token:
type: string
# --------------------------- tokens ---------------------------
Token:
title: Token
type: object
properties:
id:
type: string
readOnly: true
created_at:
type: integer
readOnly: true
updated_at:
type: integer
readOnly: true
last_login:
type: string
readOnly: true
api_access:
type: string
enum:
- disabled
- enabled
description: "Enable/disable API access. If disabled, it can only be used to open tunnel connections or forward webhooks but not change any existing configuration"
example: "enabled"
description:
type: string
scopes:
type: object
$ref: '#/definitions/TokenScopes'
TokenCreateResponse:
title: Token Create Response
type: object
properties:
key:
type: string
description: "Token key, this is an alias to token ID"
secret:
type: string
description: "This is the only time secret is revealed as it is already encrypted by the system"
TokenScopes:
title: TokenScopes
type: object
properties:
tunnels:
type: array
items:
type: string
buckets:
type: array
items:
type: string
# --------------------------- buckets ---------------------------
HeaderItem:
title: Header values
type: "array"
items:
type: string
Headers:
title: Headers for request/response
type: object
# map[string][]string
additionalProperties: {
$ref: '#/definitions/HeaderItem'
}
description: A hashmap of header keys and a list of values for each string, Go equivalent map[string][]string
example:
Content-Type:
- JSON
Foo:
- Bar
BucketRequest: