-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1158 lines (1118 loc) · 30.6 KB
/
Copy pathopenapi.yaml
File metadata and controls
1158 lines (1118 loc) · 30.6 KB
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
openapi: 3.1.0
info:
title: VPN Smart-Sub Worker API
version: 5.9.0
description: Censorship-resistant VPN subscription API generating multi-protocol configs
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://sub.example.com
description: Primary (Cloudflare Pages)
- url: https://sub.example.net
description: Backup (Vercel Edge)
tags:
- name: Health
description: Server health checks and reporting
- name: Subscription
description: VPN subscription config generation
- name: Admin Users
description: User management (admin only)
- name: Admin Servers
description: Server management (admin only)
- name: Probes
description: Network probe collection and reporting
- name: Diagnostic
description: User-facing diagnostic utilities
security: []
paths:
/health:
get:
operationId: getHealth
summary: Server health status
description: >
Returns health status of all servers. Optionally pass admin UUID
via `key` query param to include sensitive fields (ip, provider, enabled).
tags: [Health]
security:
- {}
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AdminKeyOptional'
responses:
'200':
description: Health status
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
examples:
public:
summary: Public view
value:
servers:
- tag: HEL
location: Helsinki, FI
protocols: [reality, hy2, xhttp, shadowtls]
health: healthy
latency_ms: null
last_check: null
server_count: 4
checked_at: '2026-03-09T12:00:00.000Z'
admin:
summary: Admin view (with key)
value:
servers:
- tag: HEL
location: Helsinki, FI
protocols: [reality, hy2, xhttp, shadowtls]
health: healthy
latency_ms: null
last_check: null
ip: 1.2.3.4
provider: Hetzner
enabled: true
server_count: 4
checked_at: '2026-03-09T12:00:00.000Z'
/health/report:
post:
operationId: postHealthReport
summary: Submit health check results
tags: [Health]
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [results]
properties:
results:
type: array
items:
type: object
required: [tag, status]
properties:
tag:
type: string
example: HEL
status:
type: string
enum: [healthy, degraded, down]
example: healthy
latency_ms:
type: integer
example: 45
responses:
'200':
description: Report accepted
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
updated:
type: integer
example: 1
'401':
$ref: '#/components/responses/Unauthorized'
/stats:
get:
operationId: getStats
summary: Worker statistics (admin)
tags: [Health]
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AdminKeyRequired'
responses:
'200':
description: Worker statistics
content:
application/json:
schema:
$ref: '#/components/schemas/StatsResponse'
example:
servers:
- tag: helsinki
location: Finland
enabled: true
health:
status: unknown
users:
- name: alice
tier: premium
enabled: true
source: env
uuid_prefix: a1b2c3
sub_requests:
today: {}
yesterday: {}
total_servers: 4
total_users: 5
worker_version: '5.9.0'
checked_at: '2026-03-09T12:00:00.000Z'
'401':
$ref: '#/components/responses/Unauthorized'
/sub/{uuid}:
get:
operationId: getSubscription
summary: Generate VPN subscription configs
description: >
Returns multi-protocol VPN configs for the given user UUID.
The UUID in the path acts as authentication.
tags: [Subscription]
security: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
- name: format
in: query
schema:
type: string
enum: [base64, json]
default: base64
- name: geo
in: query
description: Override geo detection
schema:
type: string
enum: [ir, global]
- name: mode
in: query
description: Special mode flag
schema:
type: string
enum: [shutdown]
responses:
'200':
description: Subscription configs
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
text/plain:
schema:
type: string
description: Base64-encoded subscription lines (default format)
example: dmxlc3M6Ly9leGFtcGxlLi4uCnNzOi8vZXhhbXBsZS4uLg==
application/json:
schema:
$ref: '#/components/schemas/SubscriptionJsonResponse'
example:
configs:
- 'vless://uuid@example.com:443?...'
- 'ss://method:pass@host:port'
user: alice
geo:
country: IR
cdn_only: true
fragment: true
mux: true
'401':
description: Invalid or unknown UUID
content:
text/plain:
schema:
type: string
example: Unauthorized
'403':
description: Expired subscription
content:
text/plain:
schema:
type: string
'404':
description: Malformed UUID format
content:
text/plain:
schema:
type: string
'429':
$ref: '#/components/responses/RateLimited'
/mtproto/{uuid}:
get:
operationId: getMtproto
summary: MTProto / Telegram proxy links
tags: [Subscription]
security: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
- name: format
in: query
schema:
type: string
enum: [json]
responses:
'200':
description: MTProto proxy links
content:
text/html:
schema:
type: string
description: HTML page with Telegram proxy links (default)
application/json:
schema:
type: object
description: JSON with proxy links (when format=json)
'401':
description: Invalid or unknown UUID
content:
text/plain:
schema:
type: string
example: Unauthorized
'403':
description: Expired subscription
content:
text/plain:
schema:
type: string
'404':
description: Malformed UUID format
content:
text/plain:
schema:
type: string
'429':
$ref: '#/components/responses/RateLimited'
/diagnostic:
get:
operationId: getDiagnostic
summary: User diagnostic guide
description: Returns a plain text diagnostic guide for end users.
tags: [Diagnostic]
security: []
responses:
'200':
description: Diagnostic guide
content:
text/plain:
schema:
type: string
/probe:
get:
operationId: getProbeScript
summary: Download probe script
tags: [Probes]
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AdminKeyRequired'
responses:
'200':
description: Bash probe script
content:
text/plain:
schema:
type: string
description: Bash script content
'403':
$ref: '#/components/responses/Forbidden'
/probe/report:
post:
operationId: postProbeReport
summary: Submit probe results
tags: [Probes]
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AdminKeyRequired'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProbeReportRequest'
example:
up: 10
down: 2
isp: MCI
country: IR
city: Tehran
results:
- tag: HEL
protocol: reality
status: up
latency_ms: 120
responses:
'200':
description: Report stored
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
stored:
type: boolean
example: true
timestamp:
type: string
example: '2026-03-09T12:00:00.000Z'
'400':
description: Invalid JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Invalid JSON
'403':
$ref: '#/components/responses/Forbidden'
'503':
$ref: '#/components/responses/KVUnavailable'
/admin/users:
get:
operationId: listUsers
summary: List all users
tags: [Admin Users]
security:
- BearerAuth: []
responses:
'200':
description: User list
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
type: object
properties:
users:
type: array
items:
$ref: '#/components/schemas/UserDetail'
total:
type: integer
example: 5
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
post:
operationId: createUser
summary: Create a new user
tags: [Admin Users]
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [name]
properties:
name:
type: string
example: bob
tier:
type: string
enum: [premium, free, limited]
default: premium
expires:
type: string
format: date-time
description: ISO 8601 expiry date (optional)
example: '2027-01-01T00:00:00Z'
responses:
'201':
description: User created
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreated'
example:
uuid: 550e8400-e29b-41d4-a716-446655440000
sub_url: https://sub.example.com/sub/550e8400-e29b-41d4-a716-446655440000
name: bob
tier: premium
enabled: true
expires: null
created_at: '2026-03-09T12:00:00.000Z'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
missing_name:
value:
error: name is required
bad_json:
value:
error: Invalid JSON
'401':
$ref: '#/components/responses/Unauthorized'
/admin/users/{uuid}:
patch:
operationId: updateUser
summary: Update a user
tags: [Admin Users]
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/UserUuid'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
tier:
type: string
enum: [premium, free, limited]
enabled:
type: boolean
expires:
type: string
format: date-time
example:
tier: free
enabled: false
responses:
'200':
description: User updated
content:
application/json:
schema:
$ref: '#/components/schemas/UserFull'
example:
uuid: 550e8400-e29b-41d4-a716-446655440000
name: bob
tier: free
enabled: false
expires: null
created_at: '2026-03-09T12:00:00.000Z'
source: kv
'400':
description: Invalid UUID or JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: User not found
'503':
$ref: '#/components/responses/KVUnavailable'
delete:
operationId: deleteUser
summary: Delete a user
tags: [Admin Users]
security:
- BearerAuth: []
parameters:
- $ref: '#/components/parameters/UserUuid'
responses:
'200':
description: User deleted
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
deleted:
type: string
example: 550e8400-e29b-41d4-a716-446655440000
'400':
description: Invalid UUID
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Cannot delete admin user
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Cannot delete admin user
/admin/servers:
get:
operationId: listServers
summary: List all servers
tags: [Admin Servers]
security:
- BearerAuth: []
responses:
'200':
description: Server list
content:
application/json:
schema:
type: object
properties:
servers:
type: array
items:
$ref: '#/components/schemas/ServerDetail'
total:
type: integer
example: 4
example:
servers:
- tag: HEL
location: Helsinki, FI
provider: Hetzner
ip: 1.2.3.4
ipv6: null
enabled: true
has_override: false
override: null
env_ip: 1.2.3.4
total: 4
'401':
$ref: '#/components/responses/Unauthorized'
/admin/servers/{tag}:
patch:
operationId: updateServer
summary: Update a server
tags: [Admin Servers]
security:
- BearerAuth: []
parameters:
- name: tag
in: path
required: true
schema:
type: string
example: HEL
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ip:
type: string
format: ipv4
ipv6:
type: string
format: ipv6
enabled:
type: boolean
example:
ip: 5.6.7.8
enabled: true
responses:
'200':
description: Server updated
content:
application/json:
schema:
$ref: '#/components/schemas/ServerDetail'
'400':
description: Invalid JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Server not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Server not found
'503':
$ref: '#/components/responses/KVUnavailable'
/admin/probes:
get:
operationId: listProbes
summary: List probe reports
tags: [Probes]
security:
- BearerAuth: []
responses:
'200':
description: Probe reports
content:
application/json:
schema:
type: object
properties:
summary:
type: object
reports:
type: array
items:
type: object
'401':
$ref: '#/components/responses/Unauthorized'
'503':
$ref: '#/components/responses/KVUnavailable'
delete:
operationId: deleteProbes
summary: Clear all probe reports
tags: [Probes]
security:
- BearerAuth: []
responses:
'200':
description: Probes deleted
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: true
deleted:
type: integer
example: 5
'401':
$ref: '#/components/responses/Unauthorized'
'503':
$ref: '#/components/responses/KVUnavailable'
/:
get:
operationId: root
summary: Root path
description: Returns 404 Not Found
tags: [Diagnostic]
security: []
responses:
'404':
description: Not Found
content:
text/plain:
schema:
type: string
example: Not Found
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Admin UUID passed as Bearer token in Authorization header
ApiKeyAuth:
type: apiKey
in: query
name: key
description: Admin UUID passed as `key` query parameter
parameters:
AdminKeyOptional:
name: key
in: query
description: Admin UUID for extended info (optional)
required: false
schema:
type: string
format: uuid
AdminKeyRequired:
name: key
in: query
description: Admin UUID (required)
required: true
schema:
type: string
format: uuid
UserUuid:
name: uuid
in: path
required: true
description: User UUID
schema:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Unauthorized
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Forbidden
KVUnavailable:
description: KV storage not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: KV not available
RateLimited:
description: Too many requests
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Rate limit exceeded
headers:
X-RateLimit-Limit:
description: Maximum requests allowed in the current window
schema:
type: integer
example: 60
X-RateLimit-Remaining:
description: Remaining requests in the current window
schema:
type: integer
example: 57
X-RateLimit-Reset:
description: UTC epoch seconds when the rate limit window resets
schema:
type: integer
example: 1711468800
schemas:
ErrorResponse:
type: object
required: [error]
properties:
error:
type: string
example:
error: Something went wrong
ServerHealth:
type: object
required: [tag, location, protocols, health]
properties:
tag:
type: string
example: HEL
location:
type: string
example: Helsinki, FI
protocols:
type: array
items:
type: string
example: [reality, hy2, xhttp, shadowtls]
health:
type: string
enum: [healthy, degraded, down, unknown]
example: healthy
latency_ms:
type: ['integer', 'null']
example: null
last_check:
type: ['string', 'null']
format: date-time
example: null
ip:
type: string
description: Only in admin view
provider:
type: string
description: Only in admin view
enabled:
type: boolean
description: Only in admin view
HealthResponse:
type: object
required: [servers, server_count, checked_at]
properties:
servers:
type: array
items:
$ref: '#/components/schemas/ServerHealth'
server_count:
type: integer
example: 4
checked_at:
type: string
format: date-time
example: '2026-03-09T12:00:00.000Z'
StatsResponse:
type: object
properties:
servers:
type: array
items:
type: object
properties:
tag:
type: string
example: helsinki
location:
type: string
example: Finland
enabled:
type: boolean
health:
type: object
properties:
status:
type: string
enum: [healthy, degraded, down, unknown]
example: unknown
latency_ms:
type: ['integer', 'null']
last_check:
type: ['string', 'null']
users:
type: array
items:
type: object
properties:
name:
type: string
example: alice
tier:
type: string
enum: [premium, free, limited]
enabled:
type: boolean
source:
type: string
enum: [env, kv]
uuid_prefix:
type: string
example: a1b2c3
sub_requests:
type: object
properties:
today:
type: object
yesterday:
type: object
total_servers:
type: integer
example: 4
total_users:
type: integer
example: 5
worker_version:
type: string
example: '5.9.0'
checked_at:
type: string
format: date-time
GeoInfo:
type: object
properties:
country:
type: string
example: IR
cdn_only:
type: boolean
example: true
fragment:
type: boolean
example: false
mux:
type: boolean
example: false
SubscriptionJsonResponse: